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/messages/?type=notSent

Gets a paginated list of messages that were not sent, ordered from oldest to newest.

NameTypeDescription
typestringRequiredOnly notSent is supported.
$pageSizeintegerNumber of messageKeys (array elements) to return per response page.
lastEventIdintegerEvent ID from which you want the response to start. To obtain the initial event ID, submit a request without a lastEventId. The events in the response are listed top to bottom from oldest to newest.
StatusNameTypeDescription
200  Success. Review example response.
 lastEventIDintegerEvent ID from which you want the response to start. To obtain the initial event ID, submit a request without a lastEventId. The events in the response are listed top to bottom from oldest to newest.
 statusCodeintegerInteger value of the reason the send did not complete. Review Send Error Codes for more information.
 statusMessagestringThe reason the send did not complete. Review Send Error Codes for more information.
 eventCategoryTypestringTransactionalSendEvent event type. SMSSent indicates that the message was sent for delivery. SMSNotSent indicates that the message was not sent and includes the reason. SMSQueued indicates that the SMS has not yet been processed for sending.
 timestampstringTime the event occured in Central Standard Time (no daylight savings)
 definitionKeystringUnique identifier of the definition.
 eventIDintegerNumeric identifier of the event.
 messageKeystringUnique identifier to track message send status.
 contactKeystringUnique identifier for a subscriber.
 tostringChannel address of the recipient. For SMS, it’s the recipient's mobile address.
ResponseReason
200 OKSuccess. Review example response.
400 Bad RequestInvalid request
401 UnauthorizedFailed to pass authorization.
500 Server ErrorInternal error