Sign in

v1

latestOpenAPI 3.0.32026-07-26870417.2 KB
queue

Get Broadcast Status

Retrieves the status of a broadcast message by its ID

get/queue/broadcast

Query parameters

broadcast_idstring required
Example:22b2a2a4-3c61-4b94-807c-fa431e71a8e5

The unique identifier of the broadcast

Headers

x-phonestring
Example:{{orgPhone}}

Please provide the number of the phone you want to call with this API in the header. The number must be in country code + number format without any characters or spaces, e.g. 919876543210; Alternatively, provide the phone_id (phone-xxxxxxxxxxxx) in the header

Response

Successful operation

broadcast_idstring

Unique identifier for the broadcast message

org_idstring

Organization identifier that owns the broadcast

created_atstring date-time

Timestamp when the broadcast was created

total_chatsinteger

Total number of chat instances targeted by this broadcast

sent_chatsinteger

Number of chats where the broadcast has been successfully sent

failed_chatsinteger

Number of chats where the broadcast failed to send

pending_chatsinteger

Number of chats where the broadcast is queued but not yet sent

total_delivered_countinteger nullable

Total count of broadcast messages delivered to recipients

total_read_countinteger nullable

Total count of broadcast messages that have been read by recipients

performed_bystring

Identifier of the user or system that initiated the broadcast

performed_atstring date-time nullable

Timestamp when the broadcast was executed

scheduled_atstring date-time

Timestamp when the broadcast is scheduled to be sent

broadcast_statusstring nullable

Current status of the broadcast (pending, in-progress, completed, failed, etc.)

total_member_countinteger

Total number of members eligible to receive this broadcast

delivered_percentagenumber float

Percentage of messages successfully delivered to recipients

read_percentagenumber float

Percentage of delivered messages that have been read by recipients

logsstring[]

List of log entries related to the broadcast's execution

Example response

{
  "broadcast_id": "22b2a2a4-3c61-4b94-807c-fa431e71a8e5",
  "org_id": "5fb0d69a-d789-4429-970e-66d48e381c9b",
  "message_payload": {
    "body": "#generalteam#",
    "message_type": "chat",
    "performed_by": "api"
  },
  "created_at": "2025-03-10T11:11:20.049901+00:00",
  "total_chats": 2,
  "performed_by": "5fb0d69a-d789-4429-970e-66d48e381c9b",
  "scheduled_at": "2025-03-10T12:11:19.52+00:00",
  "logs": []
}