SMS events
Acoustic Exchange defines several recognized events for SMS messaging.
- Message sent from an SMS program An indication that an SMS message was sent, including carrier and delivery status.
- Interaction with an SMS program An indication that an SMS message recipient responded to your text.
- Interaction with a multi-step SMS program An indication that a message recipient engaged with a multi-step SMS program.
- Clicked a link in an SMS An indication that a message recipient selected a link in an SMS.
Note:
Delivery receipts might not be available for select SMS messaging codes.
Message sent from an SMS program
Information that describes what happens when a message is sent from an SMS program.
Event code: sentSMS
Event attributes
| Attribute Name | Data Type | Example | Description | Required |
|---|---|---|---|---|
| campaignName | string | Spring Campaign | The campaign name. | |
| carrierNetwork | string | NetworkMobile | The carrier network. | |
| code | string | 45876 | A short code or long code used in the message. | |
| deliveryStatus | string | Delivered | The delivery status of the SMS (for example, sent, failed, delivered). | |
| description | string | A description of the published event to allow Exchange users to understand the event context. | ||
| eventId | string | 12345 | Unique ID to identify the type of event and enable lookup in the system. | |
| eventName | string | Interacted SMS | Short name for the published event. | Yes |
| locationCountry | string | +1 | The international dialing country code for the country in which the promotion is taking place. | |
| messageBody | string | Complete SMS message. | ||
| messageType | string | Autoresponder | The type of SMS message. | |
| programId | string | P1 | The ID of the program. | |
| programName | string | Program 1 | The name of the program. | |
| programType | string | Type 1 | The program type. | |
| statusCode | string | The delivery status code. | ||
| Source | string | List import source. | ||
| Tags | string | The tags used in the program. |
Interaction with an SMS program
Information that describes the interaction between a mobile user and an SMS program.
Event code: interactedSMS
Event attributes
| Attribute Name | Data Type | Example | Description | Required |
|---|---|---|---|---|
| campaignName | string | Spring Campaign | The promotional campaign name. | |
| carrierNetwork | string | NetworkMobile | The carrier network. | |
| code | string | 45876 | A short code or long code used in the message. | |
| description | string | Description of the published event to allow users to understand the event context. | ||
| eventId | string | 12345 | Unique ID to identify the type of event and enable lookup in the system. | |
| eventName | string | Interacted SMS | Short name for the published event. | |
| locationCountry | string | +1 | The international dialing country code for the country in which the promotion is taking place. | |
| messageBody | string | Complete SMS message. | ||
| messageType | string | Autoresponder | The type of SMS message. | |
| programId | string | P1 | The ID of the program. | |
| programName | string | Program 1 | The name of the program. | |
| programType | string | Type 1 | The program type. | |
| setConsent | string | Opted-in | Customer consent for Opted-in or Opted-out. | |
| Source | string | List import source. | ||
| Tags | string | The tags used in the program. |
Interaction with a multi-step SMS program
Information that describes the interaction between a mobile user and a multi-step SMS program.
Event code: multiStepSMS
Event attributes
| Attribute Name | Data Type | Example | Description | Required |
|---|---|---|---|---|
| campaignName | string | Spring Campaign | The campaign name. | |
| carrierNetwork | string | NetworkMobile. | The carrier network. | |
| code | string | 45976 | A short code or long code used in the message. | |
| deliveryStatus | string | Delivered | The delivery status of the SMS (for example, sent, failed, delivered). | |
| description | string | A description of the published event to allow users to understand the event context. | ||
| eventId | string | 12345 | Unique ID to identify the type of event and enable lookup in the system. | |
| eventName | string | Interacted SMS | Short name for the published event. | Yes |
| locationCountry | string | +1 | The international dialing country code for the country in which the promotion is taking place. | |
| messageBody | string | Complete SMS message. | ||
| messageType | string | Autoresponder | The type of SMS message. | |
| programId | string | Program 1 | The name of the program. | |
| programType | string | Type 1 | The program type. | |
| statusCode | string | The delivery status code. | ||
| Source | string | List import source. | ||
| stepName | string | Step 1 | The name of the inbound or outbound step. | |
| Tags | string | The tags used in the program. |
Clicked on link in SMS message
Information that describes a message recipient selecting a link in an SMS.
Event code: smsClick
Event attributes
| Attribute Name | Data Type | Example | Description | Required |
|---|---|---|---|---|
| eventId | string | 12345 | Unique ID to identify the type of event and enable lookup in the system. | |
| eventName | string | Clicked link in SMS | Short name for the published event. | Yes |
| description | string | A description of the published event to allow users to understand the event context. | ||
| mobileNumber | string | 1-555-555-1234 | The mobile number that is associated with the event. | |
| programName | string | Program 1 | The name of the program. | |
| programId | string | P1 | The ID of the program. | |
| urlDescription | string | Link name or description. | ||
| clickUrl | string | Unpersonalized long URL. | ||
| source | string | List import source. | ||
| messageName | string | The SMS message name. |
Updated over 3 years ago