WhatsApp Business API

Wpbox API Reference

Integrate with WhatsApp Cloud API to send messages, manage contacts, run campaigns, and automate customer communication at scale.

Overview

The Wpbox API provides programmatic access to WhatsApp Business features. Built on top of the Meta WhatsApp Cloud API (v19.0), it enables you to send messages, manage contacts, create campaigns, and work with approved message templates.

Base URL

https://api.wacm.in/api/v1

All endpoints require authentication via Bearer token or query parameter. The API supports both GET and POST methods for most endpoints for maximum compatibility.

Pagination

List endpoints (contacts, campaigns, conversations) return paginated responses. Use ?page= and ?limit= query parameters:

Paginated Request

curl -H "Authorization: Bearer YOUR_TOKEN" \
     "https://api.wacm.in/api/v1/contacts?page=2&limit=20"

Paginated Response

{
  "data": [...],
  "links": {
    "first": "...",
    "last": "...",
    "prev": "...",
    "next": "..."
  },
  "meta": {
    "current_page": 2,
    "last_page": 5,
    "per_page": 20,
    "total": 100
  }
}

Use ?search= to filter results by name or phone number.

Authentication

Use your Personal Access Token from the WACM dashboard (Settings → API) to authenticate requests.

Example Request

curl -X GET "https://api.wacm.in/api/v1/contacts" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Webhook Setup

Configure your WhatsApp webhook URL in the Meta Developer Console to receive incoming messages and status updates.

Webhook URL

https://yourdomain.com/api/wpbox/{your_sanctum_token}

The webhook accepts both GET (verification) and POST (message delivery) requests. Use a Laravel Sanctum personal access token for verification.

Webhook Payload - Incoming Message

Text Message Payload

{
  "entry": [{
    "id": "WABA_ID",
    "changes": [{
      "value": {
        "messaging_product": "whatsapp",
        "messages": [{
          "from": "919876543210",
          "id": "wamid.XXX",
          "timestamp": "1234567890",
          "type": "text",
          "text": { "body": "Hello" }
        }],
        "contacts": [{
          "profile": { "name": "John Doe" },
          "wa_id": "919876543210"
        }]
      }
    }]
  }]
}

Webhook Payload - Status Update

Status Update Payload

{
  "entry": [{
    "changes": [{
      "value": {
        "messaging_product": "whatsapp",
        "statuses": [{
          "id": "wamid.XXX",
          "status": "delivered",
          "timestamp": "1234567890",
          "recipient_id": "919876543210"
        }]
      }
    }]
  }]
}

Profile

GET

/me

Get authenticated user profile

Response

{
  "id": 1,
  "name": "John Doe",
  "email": "john@example.com",
  "company_id": 1,
  "role": "owner"
}

Contacts

GET

/contacts

List all contacts with pagination (page, limit, search)

POST

/contacts

Create a new contact

GET

/contacts/{id}

Get contact details with groups and fields

PUT

/contacts/{id}

Update contact information

DELETE

/contacts/{id}

Delete contact

GET

/contacts/{id}/groups-and-fields

Get contact groups and custom fields

GET

/contacts/{id}/notes

Get contact notes

POST

/contacts/check-phone

Check if phone number exists on WhatsApp

Create Contact

Request

curl -X POST "https://api.wacm.in/api/v1/contacts" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "phone": "+919876543210",
    "email": "john@example.com"
  }'

Request Body

Parameter	Type	Required	Description
name	string	Required	Contact full name
phone	string	Required	WhatsApp phone number with country code
email	string	Optional	Contact email address
country_id	integer	Optional	Country ID reference
user_id	integer	Optional	Assigned agent/user ID

Response

201 Created

{
  "id": 123,
  "name": "John Doe",
  "phone": "+919876543210",
  "email": "john@example.com",
  "avatar": null,
  "enabled_ai_bot": true,
  "subscribed": true,
  "created_at": "2025-01-15T10:30:00.000000Z"
}

Messages

POST

/messages/text

Send a text message

GET

/messages/text

Send a text message (GET)

POST

/messages/template

Send an approved template message

GET

/messages/template

Send template message (GET)

POST

/messages/list

Send an interactive list message

GET

/messages/list

Send list message (GET)

GET vs POST

Message endpoints support both GET and POST methods. Use POST for complex payloads (templates, lists). Use GET for simple text messages where parameters are passed as query strings.

Send Text Message

Request

curl -X POST "https://api.wacm.in/api/v1/messages/text" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+919876543210",
    "message": "Hello! This is a test message from WACM API."
  }'

Request Body

Parameter	Type	Required	Description
phone	string	Required	Recipient WhatsApp number
message	string	Required	Message text content

Send Template Message

Request

curl -X POST "https://api.wacm.in/api/v1/messages/template" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+919876543210",
    "template_name": "order_confirmation",
    "language": "en",
    "variables": {
      "1": "John Doe",
      "2": "ORD-12345"
    }
  }'

Send List Message

Request

curl -X POST "https://api.wacm.in/api/v1/messages/list" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+919876543210",
    "header": "Choose an option",
    "body": "Please select from the options below:",
    "footer": "Powered by WACM",
    "button_text": "View Options",
    "sections": [
      {
        "title": "Main Menu",
        "rows": [
          { "id": "opt1", "title": "Check Order Status" },
          { "id": "opt2", "title": "Talk to Support" }
        ]
      }
    ]
  }'

Templates

GET

/templates

List all approved templates

GET

/templates/{id}

Get template details

Response

200 OK

{
  "data": [
    {
      "id": 1,
      "name": "order_confirmation",
      "status": "APPROVED",
      "category": "UTILITY",
      "language": "en",
      "components": [...],
      "created_at": "2025-01-15T10:30:00.000000Z"
    }
  ]
}

Groups

GET

/groups

List all contact groups

Response

{
  "data": [
    {
      "id": 1,
      "name": "VIP Customers",
      "contact_count": 150,
      "created_at": "2025-01-15T10:30:00.000000Z"
    }
  ]
}

Campaigns

GET

/campaigns

List all campaigns with pagination (page, limit, search)

POST

/campaigns

Create a new campaign

GET

/campaigns/{id}

Get campaign statistics and details

PUT

/campaigns/{id}

Update campaign status (pause/resume)

DELETE

/campaigns/{id}

Delete a campaign

POST

/campaigns/send

Dispatch a campaign message to a contact dynamically

Create Campaign

Request

curl -X POST "https://api.wacm.in/api/v1/campaigns" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Summer Sale 2025",
    "template_id": 1,
    "group_id": null,
    "send_now": true,
    "paramvalues": {
      "1": "Summer Sale",
      "2": "50% OFF"
    }
  }'

Request Body

Parameter	Type	Required	Description
name	string	Required	Campaign name
template_id	integer	Required	WhatsApp template ID
group_id	integer	Optional	Target group ID (null = all contacts)
send_now	boolean	Optional	Send immediately (true) or schedule later (false)
send_time	string	Optional	Time to send if send_now is false
paramvalues	object	Optional	Template variable mapping values
pdf	file	Optional	Multipart form data for PDF attachments
imageupload	file	Optional	Multipart form data for Image/Video attachments

Conversations

GET

/conversations

List all conversations with pagination (page, limit, search)

GET

/conversations/{id}/messages

Get conversation messages with pagination (limit, before_id, search)

Get Conversation Messages

Response

{
  "data": [
    {
      "id": 1,
      "contact_id": 123,
      "value": "Hello! How can I help you?",
      "is_message_by_contact": 0,
      "message_type": 1,
      "status": 4,
      "created_at": "2025-01-15T10:30:00.000000Z"
    },
    {
      "id": 2,
      "contact_id": 123,
      "value": "I need help with my order",
      "is_message_by_contact": 1,
      "message_type": 1,
      "status": 4,
      "created_at": "2025-01-15T10:31:00.000000Z"
    }
  ]
}

Message Types Reference

Type	Code	Description
TEXT	1	Plain text message
MEDIA	2	Image, video, document, or audio
LOCATION	3	Location share (Google Maps)
NFM_REPLY	5	Interactive flow reply

Message Status Codes

0Scheduled - Message queued for sending

1Sending - Message being sent to WhatsApp

2Sent - WhatsApp accepted the message

3Delivered - Message delivered to device

4Read - Message read by recipient

5Failed - Message failed to send

Error Responses

400Bad Request - Invalid parameters or payload

401Unauthorized - Invalid or missing API token

403Forbidden - Insufficient permissions or plan limits

404Not Found - Resource does not exist

429Too Many Requests - Rate limit exceeded

500Internal Server Error - Something went wrong

Error Response Format

Error Response

{
  "message": "The phone number is required.",
  "errors": {
    "phone": ["The phone field is required."]
  }
}

eCommerce Store API

Manage products, categories, and orders.

View Docs