Sign in

v1

latestOpenAPI 3.0.32026-07-26870417.2 KB
message

List Queue Jobs

This endpoint returns the jobs in the message queue. Optionally filter by queue_id or broadcast_id

Note: To check the status of a broadcast, pass the broadcast_id in the request body. This will return all jobs associated with that broadcast

post/message/queues

Headers

x-phonestring
Example:918527184400

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

Request body

queue_idstring

Filter by a specific message queue

broadcast_idstring

Filter by broadcast ID to return all jobs belonging to this broadcast

Example request

{
  "queue_id": "5df4cb6d-9f2b-46b6-936e-8e6f4b1a5400",
  "broadcast_id": "b25192d5-2370-4a69-b844-aae5e2bfae92"
}

Response

200 OK

queue_idstring

Unique identifier for the message queue

unique_idstring

Provisional message identifier, useful for tracking via /message/{unique_id}/status

message_idstring

A unique identifier for the message, containing information about the chat, sender, and message details.

chat_idstring

The recipient's chat ID, the unique identifier of the WhatsApp chat

performed_bystring

Identifier of who initiated the message (e.g. api, user)

status'queued' | 'sending' | 'sent' | 'failed' | 'scheduled'

Current status of the job (queued, sending, sent, failed, scheduled, pending, delivered, read, played)

status_descriptionstring

Description of the current status of the message

attemptsinteger

Number of send attempts made

Example response

[
  {
    "queue_id": "5df4cb6d-9f2b-46b6-936e-8e6f4b1a5400",
    "unique_id": "3EB0A0A8F90A01259C81A3",
    "message_id": "true_8824248940@c.us_3EB0A0A8F90A01259C81A3",
    "chat_id": "8824248940@c.us",
    "performed_by": "api",
    "status": "sent",
    "status_description": "Successfully submitted.",
    "message": {
      "body": "Hello",
      "type": "chat"
    },
    "timeline": {
      "queued_at": "2026-04-01T14:23:21.279Z",
      "sent_at": "2026-04-01T14:23:24.111Z"
    },
    "attempts": 1
  }
]