Poll broadcast status

Poll the status of the event used to send a broadcast.

The field at the $.result.stats JSONPath correspond to the broadcast statistics.

Message status for individual template messages can be accessed from the API endpoint specified at the$.result.template_messages_url JSONPath.

Responses

🟢200Success

application/json

Body

string

required

status

enum<string>

required

Allowed values:

processedfailed

result

object | null

required

type

enum<string>

required

Allowed value:

campaign

string

required

name

string

required

audience_count

integer

required

phone_number

string

required

launch_time

string

required

stats

object

required

whats_app_template

object

required

template_messages_url

string

required

Example:

https://app.trypeach.io/api/v1/template_messages?broadcast_id= cmp_5678efgh

Examples

Successful BroadcastFailed Broadcast

{
    "id": "evt_1234abcd",
    "status": "processed",
    "result": {
        "type": "campaign",
        "id": "cmp_5678efgh",
        "name": "Instant Broadcast via API",
        "audience_count": 2,
        "phone_number": "+91 99887 76655",
        "launch_time": "2025-05-19T10:00:00Z",
        "stats": {
            "delivered": 1,
            "read": 0,
            "engaged": 0,
            "unsubscribed": 0,
            "queued": 0,
            "sent": 1,
            "failures": 0,
            "unknown": 0
        },
        "whats_app_template": {
            "id": "wat_1234abcd",
            "name": "Test Template"
        },
        "template_messages_url": "https://app.trypeach.io/api/v1/template_messages?broadcast_id=cmp_5678efgh"
    }
}

Poll broadcast status

Request

Request samples

Responses