Transactional SMS Events

The Event Notification Service supports these event notification types.

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.

AttributeTypeDescription
compositeIdstringA unique tracking ID for the event
definitionKeystringThe external key of the Send Definition that’s associated with the message
eidnumberThe Enterprise ID (EID) of the account that produced the event
eventCategoryTypestringThe SMS event type
infoobjectAn object that contains information about the message
info.messageKeystringA unique ID for the message
info.subscriberKeystringThe recipient’s unique subscriber key
info.tostringThe recipient’s mobile number
midnumberThe Member ID (MID) of the account that produced the event
timestampUTCnumberA timestamp for the event

This JSON object is an example of an TransactionalSendEvents.SmsSent event payload.

[
    {
     "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.

AttributeTypeDescription
compositeIdStringA unique tracking ID for the event
definitionIdStringThe unique ID of the Send Definition that’s associated with the message
definitionKeyStringThe external key of the Send Definition
eidNumberThe Enterprise ID (EID) of the account that produced the event
eventCategoryTypeStringThe SMS event type
infoObjectAn object that contains information about the message
info.messageKeyStringA unique ID for the message
info.statusCodeStringA string that represents the reason that the message wasn’t sent
info.subscriberKeyStringThe recipient’s unique subscriber key
info.toStringThe recipient’s mobile number
midNumberThe Member ID (MID) of the account that produced the event
timestampUTCNumberA timestamp for the event

This JSON object is an example of an TransactionalSendEvents.SmsNotSent event payload.

[
  {
    "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.

AttributeTypeDescription
composite.batchIdStringThe unique ID of the batch associated with an SMS send job
composite.jobIdStringThe unique ID of the SMS send
composite.mobileNumberStringThe recipient’s mobile number
composite.subscriberIdStringThe recipient’s unique subscriber ID
composite.tsidStringThe unique ID of the triggered send that resulted in the message being sent
compositeIdStringA unique tracking ID for the event
definitionIdStringThe unique ID of the Send Definition that’s associated with the message
definitionKeyStringThe external key of the Send Definition
eidNumberThe Enterprise ID (EID) of the account that produced the event
eventCategoryTypeStringThe SMS event type
info.countryCodeStringThe two-character ISO 3166 code of the locale that the message was sent to
info.fromStringThe phone number or alphanumeric code that the message was sent from
info.messageKeyStringA unique ID for the message
info.ordinalNumberThe part in a multi-part SMS message, with the first part having a value of 0
info.statusCodeStringA code that represents the reason that the message wasn’t sent
info.statusMessageStringA string that describes why the message wasn’t sent
info.subscriberKeyStringThe recipient’s subscriber key
info.toStringThe recipient’s mobile number
midNumberThe Member ID (MID) of the account that produced the event
timestampUTCNumberA timestamp for the event

This JSON object is an example of a TransactionalSendEvents.SmsTransient event payload.

[
  {
    "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.

AttributeTypeDescription
composite.batchIdStringThe unique ID of the batch associated with an SMS send job
composite.jobIdStringThe unique ID of the SMS send
composite.mobileNumberStringThe recipient’s mobile number
composite.subscriberIdStringThe recipient’s unique subscriber ID
composite.tsidStringThe unique ID of the triggered send that resulted in the message being sent
compositeIdStringA unique tracking ID for the event
definitionIdStringThe unique ID of the Send Definition that’s associated with the message
definitionKeyStringThe external key of the Send Definition
eidNumberThe Enterprise ID (EID) of the account that produced the event
eventCategoryTypeStringThe SMS event type
info.countryCodeStringThe two-character ISO 3166 code of the locale that the message was sent to
info.fromStringThe phone number or alphanumeric code that the message was sent from
info.messageKeyStringA unique ID for the message
info.ordinalNumberThe part in a multi-part SMS message, with the first part having a value of 0
info.statusCodeStringA code that represents the reason that the message wasn’t sent
info.statusMessageStringA string that describes why the message wasn’t sent
info.subscriberKeyStringThe recipient’s subscriber key
info.toStringThe recipient’s mobile number
midNumberThe Member ID (MID) of the account that produced the event
timestampUTCNumberA timestamp for the event

This JSON object is an example of a TransactionalSendEvents.SmsDelivered event payload.

[
  {
    "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.

AttributeTypeDescription
composite.batchIdStringThe unique ID of the batch associated with an SMS send job
composite.jobIdStringThe unique ID of the SMS send
composite.mobileNumberStringThe recipient’s mobile number
composite.subscriberIdStringThe recipient’s unique subscriber ID
composite.tsidStringThe unique ID of the triggered send that resulted in the message being sent
compositeIdStringA unique tracking ID for the event
definitionIdStringThe unique ID of the Send Definition that’s associated with the message
definitionKeyStringThe external key of the Send Definition
eidNumberThe Enterprise ID (EID) of the account that produced the event
eventCategoryTypeStringThe SMS event type
info.countryCodeStringThe two-character ISO 3166 code of the locale that the message was sent to
info.fromAddressStringThe phone number or alphanumeric code that the message was sent from
info.messageKeyStringA unique ID for the message
info.ordinalNumberThe part in a multi-part SMS message, with the first part having a value of 0
info.statusCodeStringA code that represents the reason that the message wasn’t sent
info.statusMessageStringA string that describes why the message wasn’t sent
info.subscriberKeyStringThe recipient’s subscriber key
info.toStringThe recipient’s mobile number
midNumberThe Member ID (MID) of the account that produced the event
timestampUTCNumberA timestamp for the event

This JSON object is an example of a TransactionalSendEvents.SmsBounced event payload.

[
  {
    "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
  }
]

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Get Started
APIs
API Integration Security
Tenant-Specific API Endpoints
REST API
Automation Studio API
Content Builder API
Event Notification Service
Get Started with Event Notification Service
Event Notification Service Activities
Event Notification Support for OAuth 2.0
Supported Notification Events
Transactional Email Events
Engagement Email Events
Transactional SMS Events
Automation Studio Events
MobilePush Events
WhatsApp Events
Relate ENS Sent Events to Engagement Events
Subscription Filters
Notification Signing
Retries and Callback Suspensions
Journey Builder API
Fire an Entry Event
Single-Send Journeys
GroupConnect Chat Messaging API
MobileConnect API
Einstein Recommendations API
Transactional Messaging API
Bulk Data Ingest API
REST Reference
SOAP Web Service API
API Best Practices and Use Cases
API Errors
API Call Volume History and Health
Installed Packages
Programmatic Languages