Transactional SMS Events
The Event Notification Service supports these event notification types.
- TransactionalSendEvents.SmsSent
- TransactionalSendEvents.SmsNotSent
- TransactionalSendEvents.SmsTransient
- TransactionalSendEvents.SmsDelivered
- TransactionalSendEvents.SmsBounced
The content of an event payload varies based on the type of SMS event.
A TransactionalSendEvents.SmsSent event indicates that an SMS message was sent to a downstream delivery partner. The event payload contains the attributes in this table.
| Attribute | Type | Description |
|---|---|---|
compositeId | string | A unique tracking ID for the event |
definitionKey | string | The external key of the Send Definition that’s associated with the message |
eid | number | The Enterprise ID (EID) of the account that produced the event |
eventCategoryType | string | The SMS event type |
info | object | An object that contains information about the message |
info.messageKey | string | A unique ID for the message |
info.subscriberKey | string | The recipient’s unique subscriber key |
info.to | string | The recipient’s mobile number |
mid | number | The Member ID (MID) of the account that produced the event |
timestampUTC | number | A timestamp for the event |
This JSON object is an example of an TransactionalSendEvents.SmsSent event payload.
A TransactionalSendEvents.SmsNotSent event indicates that an SMS message wasn’t sent to a downstream delivery partner. The event payload contains the attributes in this table.
| Attribute | Type | Description |
|---|---|---|
compositeId | String | A unique tracking ID for the event |
definitionId | String | The unique ID of the Send Definition that’s associated with the message |
definitionKey | String | The external key of the Send Definition |
eid | Number | The Enterprise ID (EID) of the account that produced the event |
eventCategoryType | String | The SMS event type |
info | Object | An object that contains information about the message |
info.messageKey | String | A unique ID for the message |
info.statusCode | String | A string that represents the reason that the message wasn’t sent |
info.subscriberKey | String | The recipient’s unique subscriber key |
info.to | String | The recipient’s mobile number |
mid | Number | The Member ID (MID) of the account that produced the event |
timestampUTC | Number | A timestamp for the event |
This JSON object is an example of an TransactionalSendEvents.SmsNotSent event payload.
A TransactionalSendEvents.SmsTransient event indicates that a message is still being delivered. The event payload contains the attributes in this table.
| Attribute | Type | Description |
|---|---|---|
composite.batchId | String | The unique ID of the batch associated with an SMS send job |
composite.jobId | String | The unique ID of the SMS send |
composite.mobileNumber | String | The recipient’s mobile number |
composite.subscriberId | String | The recipient’s unique subscriber ID |
composite.tsid | String | The unique ID of the triggered send that resulted in the message being sent |
compositeId | String | A unique tracking ID for the event |
definitionId | String | The unique ID of the Send Definition that’s associated with the message |
definitionKey | String | The external key of the Send Definition |
eid | Number | The Enterprise ID (EID) of the account that produced the event |
eventCategoryType | String | The SMS event type |
info.countryCode | String | The two-character ISO 3166 code of the locale that the message was sent to |
info.from | String | The phone number or alphanumeric code that the message was sent from |
info.messageKey | String | A unique ID for the message |
info.ordinal | Number | The part in a multi-part SMS message, with the first part having a value of 0 |
info.statusCode | String | A code that represents the reason that the message wasn’t sent |
info.statusMessage | String | A string that describes why the message wasn’t sent |
info.subscriberKey | String | The recipient’s subscriber key |
info.to | String | The recipient’s mobile number |
mid | Number | The Member ID (MID) of the account that produced the event |
timestampUTC | Number | A timestamp for the event |
This JSON object is an example of a TransactionalSendEvents.SmsTransient event payload.
A TransactionalSendEvents.SmsDelivered event indicates that an SMS message was delivered to the recipient's device. The event payload contains the attributes in this table.
| Attribute | Type | Description |
|---|---|---|
composite.batchId | String | The unique ID of the batch associated with an SMS send job |
composite.jobId | String | The unique ID of the SMS send |
composite.mobileNumber | String | The recipient’s mobile number |
composite.subscriberId | String | The recipient’s unique subscriber ID |
composite.tsid | String | The unique ID of the triggered send that resulted in the message being sent |
compositeId | String | A unique tracking ID for the event |
definitionId | String | The unique ID of the Send Definition that’s associated with the message |
definitionKey | String | The external key of the Send Definition |
eid | Number | The Enterprise ID (EID) of the account that produced the event |
eventCategoryType | String | The SMS event type |
info.countryCode | String | The two-character ISO 3166 code of the locale that the message was sent to |
info.from | String | The phone number or alphanumeric code that the message was sent from |
info.messageKey | String | A unique ID for the message |
info.ordinal | Number | The part in a multi-part SMS message, with the first part having a value of 0 |
info.statusCode | String | A code that represents the reason that the message wasn’t sent |
info.statusMessage | String | A string that describes why the message wasn’t sent |
info.subscriberKey | String | The recipient’s subscriber key |
info.to | String | The recipient’s mobile number |
mid | Number | The Member ID (MID) of the account that produced the event |
timestampUTC | Number | A timestamp for the event |
This JSON object is an example of a TransactionalSendEvents.SmsDelivered event payload.
A TransactionalSendEvents.SmsBounced event indicates that an SMS message wasn’t delivered to the recipient’s device. The event payload contains the attributes in this table.
| Attribute | Type | Description |
|---|---|---|
composite.batchId | String | The unique ID of the batch associated with an SMS send job |
composite.jobId | String | The unique ID of the SMS send |
composite.mobileNumber | String | The recipient’s mobile number |
composite.subscriberId | String | The recipient’s unique subscriber ID |
composite.tsid | String | The unique ID of the triggered send that resulted in the message being sent |
compositeId | String | A unique tracking ID for the event |
definitionId | String | The unique ID of the Send Definition that’s associated with the message |
definitionKey | String | The external key of the Send Definition |
eid | Number | The Enterprise ID (EID) of the account that produced the event |
eventCategoryType | String | The SMS event type |
info.countryCode | String | The two-character ISO 3166 code of the locale that the message was sent to |
info.fromAddress | String | The phone number or alphanumeric code that the message was sent from |
info.messageKey | String | A unique ID for the message |
info.ordinal | Number | The part in a multi-part SMS message, with the first part having a value of 0 |
info.statusCode | String | A code that represents the reason that the message wasn’t sent |
info.statusMessage | String | A string that describes why the message wasn’t sent |
info.subscriberKey | String | The recipient’s subscriber key |
info.to | String | The recipient’s mobile number |
mid | Number | The Member ID (MID) of the account that produced the event |
timestampUTC | Number | A timestamp for the event |
This JSON object is an example of a TransactionalSendEvents.SmsBounced event payload.