GET /messaging/v1/sms/definitions/{definitionKey}/queue

Gets metrics for the messages of a send definition. Applies to messages that are accepted but not yet processed.

URL Parameters

NameTypeDescription
definitionKeystringRequiredUnique identifier of the definition.

Responses

StatusNameTypeDescription
200  OK. Review example response.
 requestIdstringThe unique identifier of this request.
 ageSecondsintegerAge of the oldest unprocessed record in the queue.
 countintegerTotal number of records waiting to be processed in the queue.

Check the queue depth and age of the oldest record not yet processed. If you set a definition to inactive and continue to send message requests to it, the count and age increase.

Example Request

Example Response