Sign in

v1

latestOpenAPI 3.0.32026-07-26870417.2 KB
queue

Get Queue Status

This endpoint returns the current status of the message queue

get/queue

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

200 OK

object required

The response is a JSON object with details about the queue running status and a summary count of the job status in the last 24 hours

  • is_running

    • If this is true, the queue is running.

    • Reverts to false when the phone connection is DISCONNECTED

  • active

    • The number of jobs currently being processed by the queue

  • completed

    • The number of jobs completed successfully in the last 24 hours

  • failed

    • The number of jobs that failed in the last 24 hours

  • pending

    • The number of jobs currently waiting in the queue