API Reference v1.0

Campaigns

Retrieve your WhatsApp campaigns and their performance metrics. Campaigns allow you to send template messages to groups of contacts with full delivery tracking.

List Campaigns

GET /api/wpbox/getCampaigns

Returns all campaigns in your account with their current status and delivery statistics. You can optionally filter by campaign type.

Query Parameters

Parameter	Type	Description
token Required	string	Your API authentication token. Found in your dashboard under Settings > API.
type Optional	string	Filter campaigns by type. If omitted, all campaigns are returned.

Example Request

cURL

curl -G "https://whatsbizapi.com/api/wpbox/getCampaigns?token=your-api-token"

cURL — with type filter

curl -G "https://whatsbizapi.com/api/wpbox/getCampaigns?token=your-api-token&type=marketing"

Example Response

Response — 200 OK

[
    {
        "id": 101,
        "name": "Summer Sale 2025",
        "template_name": "summer_sale_promo",
        "status": "completed",
        "sent_count": 1500,
        "delivered_count": 1465,
        "read_count": 1102,
        "failed_count": 35,
        "created_at": "2025-06-01T09:00:00Z"
    },
    {
        "id": 102,
        "name": "Order Follow-up Batch",
        "template_name": "order_confirmation",
        "status": "running",
        "sent_count": 340,
        "delivered_count": 312,
        "read_count": 198,
        "failed_count": 8,
        "created_at": "2025-07-10T14:30:00Z"
    }
]

Campaign Statuses

Each campaign progresses through a lifecycle represented by its status field.

Status	Description
`draft`	Campaign has been created but not yet scheduled or started.
`scheduled`	Campaign is scheduled to run at a future date and time.
`running`	Campaign is actively sending messages. Delivery counts are updating in real time.
`completed`	All messages have been processed. Final delivery statistics are available.
`failed`	Campaign encountered a critical error and was unable to complete. Check your template status and account balance.

Response Fields

Field	Type	Description
`id`	integer	Unique identifier for the campaign.
`name`	string	Display name of the campaign.
`template_name`	string	Name of the WhatsApp template used in this campaign. Must match an approved template in your account.
`status`	string	Current campaign status. See Campaign Statuses above.
`sent_count`	integer	Total number of messages sent (submitted to WhatsApp).
`delivered_count`	integer	Number of messages successfully delivered to the recipient's device.
`read_count`	integer	Number of messages that were read by the recipient. Only available when read receipts are enabled.
`failed_count`	integer	Number of messages that failed to deliver. Common reasons include invalid numbers or recipients not on WhatsApp.
`created_at`	string	ISO 8601 timestamp of when the campaign was created.

ℹ

Delivery metrics: The read_count field depends on whether recipients have read receipts enabled in their WhatsApp settings. Actual read rates may be higher than reported.

⚠

Rate limits apply: Campaign delivery speed depends on your WhatsApp Business API tier and messaging limits. New accounts start with lower limits that increase as your quality rating improves.