Skip to main content
Node.js
Deprecated. Use POST /message/queues instead. Pass queue_id or broadcast_id in the request body to filter

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

queue_id
string

Provide the queue_id of the message to filter for that job

Example:

"63cda77b-73de-433e-a652-a8f489100d43"

broadcast_id
string

Provide the broadcast_id to filter all messages of that broadcast

Example:

""

Response

200 - application/json

200 OK

The response is a JSON object of the message job. Refer to the message job object here