--- schema_version: "1" id: 957d125dee13aa5b5fd41e466b325972fff2f800ad443fc76a36aaf7eed362a1 title: Transactional SMS Events collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/marketing-cloud/guides/mc-apis/transactional_sms_events.md canonical_url: https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/transactional_sms_events.html source_site: developer.salesforce.com content_type: documentation content_hash: c198970802d91a36a5ca83de15892fb66babde27e680c0be02737044111f2884 products: - Marketing Cloud Engagement APIs and Programmatic Languages - Marketing Cloud --- # Transactional SMS Events The Event Notification Service supports these event notification types. - [TransactionalSendEvents.SmsSent](#transactional-sms-sent-event) - [TransactionalSendEvents.SmsNotSent](#transactional-sms-not-sent-event) - [TransactionalSendEvents.SmsTransient](#transactional-sms-transient-event) - [TransactionalSendEvents.SmsDelivered](#transactional-sms-delivered-event) - [TransactionalSendEvents.SmsBounced](#transactional-sms-bounced-event) The content of an event payload varies based on the type of SMS event. ## Transactional SMS Sent 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. ```json [ { "definitionKey":"SMS_TRAN_D1_PORT_BENEF_PGMTO_PIX", "info": { "to":"5522988586844", "subscriberKey":"78901472791", "messageKey":"57b98561-cec9-41ba-91b1-612cb0ce977e" }, "eventCategoryType":"TransactionalSendEvents.SmsSent", "compositeId":"api.ebe4290a-aa2d-45b6-8b67-10d40ac1576d.6b23de55-e0cb-ec11-b83c-48df37dc15e5.3444656.78901472791.0", "timestampUTC":1736548518, "eid":1982, "mid":2507 } ] ``` ## Transactional SMS Not Sent Event 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. ```json [ { "definitionId": "d7c8f8e9-3851-ef11-b856-48df37e3936e", "definitionKey": "coffee-is-a-cherry", "info": { "to": "55555155", "subscriberKey": "07580977192", "messageKey": "71F6EA63-9D10-4D88-A6FB-267D28DA4DZA", "statusCode": "4500", }, "eventCategoryType": "TransactionalSendEvents.SmsNotSent", "compositeId": "api.fce64fd7-29c8-49a9-9a3e-a0e34912d3ff.d7c8f8e9-3851-ef11-b856-48df37e3936e.1660048.07580977192.0", "timestampUTC": 1736372660, "eid": 1982, "mid": 2507 } ] ``` ## Transactional SMS Transient Event 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. ```json [ { "definitionId": "d7c8f8e9-3851-ef11-b856-48df37e3936e", "definitionKey": "coffee-is-a-cherry", "info": { "to": "55555151", "from": "62300", "subscriberKey": "71893776620", "messageKey": "4226439994", "statusCode": "3000", "statusMessage": "Enroute", "ordinal": 0, "countryCode": "BR" }, "composite": { "jobid": "fce64fd7-29c8-49a9-9a3e-a0e34912d3ff", "batchid": "1654282", "subscriberId": "16266883", "mobilenumber": "55555155", "tsid": "d7c8f8e9-3851-ef11-b856-48df37e3936e" }, "eventCategoryType": "TransactionalSendEvents.SmsTransient", "compositeId": "api.fce64fd7-29c8-49a9-9a3e-a0e34912d3ff.d7c8f8e9-3851-ef11-b856-48df37e3936e.1654282.71893776620.0", "timestampUTC": 1735659186000, "eid": 1982, "mid": 2507 } ] ``` ## Transactional SMS Delivered Event 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. ```json [ { "definitionId": "54171bb0-2369-42ac-8cf4-bac765af2e87", "definitionKey": "coffee-is-a-cherry", "info": { "to": "55155551", "from": "62300", "subscriberKey": "05397590908", "messageKey": "4226459518", "statusCode": "4000", "statusMessage": "Delivered", "ordinal": 0, "countryCode": "BR" }, "composite": { "jobid": "68353c43-3313-4296-ad75-fb78f90b678e", "batchid": "25071982", "subscriberId": "28917025", "mobilenumber": "5555515", "tsid": "b2634206-dda1-43d9-b171-86e3b557906d" }, "eventCategoryType": "TransactionalSendEvents.SmsDelivered", "compositeId": "composite", "timestampUTC": 1735659197000, "eid": 1982, "mid": 2507 } ] ``` ## Transactional SMS Bounced Event 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. ```json [ { "definitionId": "d7c8f8e9-3851-ef11-b856-48df37e3936e", "definitionKey": "coffee-is-a-cherry", "info": { "to": "55555155", "fromAddress": "62300", "subscriberKey": "07580977192", "messageKey": "4226943198", "statusCode": "4500", "statusMessage": "Undeliverable", "ordinal": 0, "countryCode": "BR" }, "composite": { "jobid": "fce64fd7-29c8-49a9-9a3e-a0e34912d3ff", "batchid": "1660048", "subscriberId": "350103404", "mobilenumber": "55155555", "tsid": "d7c8f8e9-3851-ef11-b856-48df37e3936e" }, "eventCategoryType": "TransactionalSendEvents.SmsBounced", "compositeId": "api.fce64fd7-29c8-49a9-9a3e-a0e34912d3ff.d7c8f8e9-3851-ef11-b856-48df37e3936e.1660048.07580977192.0", "timestampUTC": 1735665770000, "eid": 1982, "mid": 2507 } ] ```