The Salesforce Developers website will undergo maintenance on May 29, 2024 from 3:00 a.m. UTC to 10:00 a.m. UTC. The maintenance process may affect the availability of our documentation. Please plan accordingly.

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

Retrieves metrics for the messages associated with a send definition, including messages that haven't been processed yet.

NameTypeDescription
definitionKeystringRequired. The unique identifier of the definition.

This example checks the queue depth and age of the oldest record that hasn't been processed. If you set a definition to inactive and continue to send message requests to it, the count and age increase.

If the request is successful, the response includes a unique ID for the request. It also includes the number of records that are waiting to be processed in the queue and the age of the oldest unprocessed record in the queue.