PEperiskope
message

Status of Message Queues

This endpoint returns the current status across all the message queue

get/message/queues/health

Request

  • Base URL
    https://api.periskope.app/v1
  • URL
    https://api.periskope.app/v1/message/queues/health
  • Auth
    HTTP bearer

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

Response

200 OK

waitinginteger

Number of message jobs waiting to be processed

activeinteger

Number of message jobs currently being processed

completedinteger

Number of message jobs completed successfully

failedinteger

Number of message jobs that failed after all retry attempts

delayedinteger

Number of message jobs scheduled for a future time

pausedinteger

Number of message jobs currently paused

Example response

{
  "active": 1,
  "completed": 142,
  "failed": 3,
  "delayed": 5
}

Changes

No recorded changes to this operation across all 2 revisions of this API.