The method allows you to get detailed information about the campaign with the statistics of messages sent.
| GET http://one-api.bsg.world/api/campaigns/{id}/detail |
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| id | Yes | integer | no |
Campaign ID created using:
|
| Parameter | Type | Description | |
|---|---|---|---|
| id | integer | ID of the task created for a bulk campaign | |
| name | string | Campaign name | |
| sender | string | SMS Sender name | |
| status | string |
Campaign current status. Possible values:
| |
| type | string | campaign type – sms | |
| start_date | string | Date and time of the campaign start (scheduled). Format ISO 8601: yyyy-mm-dd hh:mm:ss | |
| actual_start_at | string | Actual date and time the campaign started. Format ISO 8601: yyyy-mm-dd hh:mm:ss | |
| finished_at | string | Date and time the campaign is completed. Format ISO 8601: yyyy-mm-dd hh:mm:ss | |
| created_at | string | Date and time the campaign is created. Format ISO 8601: yyyy-mm-dd hh:mm:ss | |
| statistics | object | Campaign statistics containing: | |
| delivered | integer | Number of messages received by the recipient | |
| scheduled | integer | Number of messages scheduled for the campaign | |
| moderation | integer | Number of messages in moderation | |
| accepted | integer | Number of messages accepted by the operator | |
| sending | integer | Number of messages in the queue for sending | |
| sent | integer | Number of messages that have been sent and are expecting to be delivered | |
| expired | integer | Number of undelivered messages (phone switched off) | |
| failed | integer | Number of messages with a send error (probably a missing prefix) | |
| undelivered | integer | Number of undelivered messages | |
| unknown | integer | Number of messages for which there is no delivery report | |
| total_messages | integer | Total number of messages created within the campaign | |
| total_phones | integer | Number of contacts in the campaign | |
| total_price | string | Total campaign price | |
| currency | string | The currency in which the campaign cost is specified. ISO 4217 format |
If the request is successful, you will receive a response:
{
"data": {
“id”: “12345”,
“name”: “string”
“sender”: “testsms”,
“status”: “done”,
“type”: “instant”,
“start_at”: “2022-01-01 00:01:02”,
“actual_start_at”: “2022-01-01 00:01:03”,
“creation_at”: “2022-01-01 00:00:01”,
“finished_at”: “2022-01-01 00:10:03”,
“statistics”: [
{
“delivered”: 0,
“scheduled”: 0,
“moderation”: 0,
“accepted”: 0,
“sending”: 20,
“sent”: 100,
“expired”: 0,
“failed”: 0,
“undelivered”: 0,
“unknown”: 0
}
]
“total_messages”: 120,
“total_phones”: 120,
“total_price”: “35,0987645”,
“currency”: “USD”
}
}
WhatsApp Business API for 2026 — setup steps, the new per-message pricing model, and proven use cases by industry.
What is CPaaS? The cloud API layer that adds SMS, WhatsApp, voice & OTP to your apps — how it works and why it beats a multi-vendor stack.
Why one communication API for SMS, WhatsApp, Viber & RCS beats five separate integrations — cascade fallback, unified reports.
