curl --request GET \
  --url https://api.periskope.app/v1/queue/broadcast \
  --header 'Authorization: Bearer <token>'
{
  "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,
  "sent_chats": 0,
  "failed_chats": 0,
  "pending_chats": 0,
  "total_delivered_count": 123,
  "total_read_count": 123,
  "performed_by": "5fb0d69a-d789-4429-970e-66d48e381c9b",
  "performed_at": "2023-11-07T05:31:56Z",
  "scheduled_at": "2025-03-10T12:11:19.52+00:00",
  "broadcast_status": "<string>",
  "total_member_count": 0,
  "delivered_percentage": 0,
  "read_percentage": 0,
  "logs": []
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-phone
string

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

Example:

"{{orgPhone}}"

Query Parameters

​
broadcast_id
string
required

The unique identifier of the broadcast

Example:

"22b2a2a4-3c61-4b94-807c-fa431e71a8e5"

Response

200 - application/json
Successful operation
​
broadcast_id
string

Unique identifier for the broadcast message

Example:

"22b2a2a4-3c61-4b94-807c-fa431e71a8e5"

​
org_id
string

Organization identifier that owns the broadcast

Example:

"5fb0d69a-d789-4429-970e-66d48e381c9b"

​
message_payload
object

Container for the broadcast message content and metadata

​
created_at
string

Timestamp when the broadcast was created

Example:

"2025-03-10T11:11:20.049901+00:00"

​
total_chats
integer

Total number of chat instances targeted by this broadcast

Example:

2

​
sent_chats
integer

Number of chats where the broadcast has been successfully sent

Example:

0

​
failed_chats
integer

Number of chats where the broadcast failed to send

Example:

0

​
pending_chats
integer

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

Example:

0

​
total_delivered_count
integer | null

Total count of broadcast messages delivered to recipients

​
total_read_count
integer | null

Total count of broadcast messages that have been read by recipients

​
performed_by
string

Identifier of the user or system that initiated the broadcast

Example:

"5fb0d69a-d789-4429-970e-66d48e381c9b"

​
performed_at
string | null

Timestamp when the broadcast was executed

​
scheduled_at
string

Timestamp when the broadcast is scheduled to be sent

Example:

"2025-03-10T12:11:19.52+00:00"

​
broadcast_status
string | null

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

​
total_member_count
integer

Total number of members eligible to receive this broadcast

Example:

0

​
delivered_percentage
number

Percentage of messages successfully delivered to recipients

Example:

0

​
read_percentage
number

Percentage of delivered messages that have been read by recipients

Example:

0

​
logs
string[]

List of log entries related to the broadcast's execution

Example:
[]

Was this page helpful?

Fetch Queue JobsGet Queue Status