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 NameData TypeExampleDescriptionRequired
campaignNamestringSpring CampaignThe campaign name.
carrierNetworkstringNetworkMobileThe carrier network.
codestring45876A short code or long code used in the message.
deliveryStatusstringDeliveredThe delivery status of the SMS (for example, sent, failed, delivered).
descriptionstringA description of the published event to allow Exchange users to understand the event context.
eventIdstring12345Unique ID to identify the type of event and enable lookup in the system.
eventNamestringInteracted SMSShort name for the published event.Yes
locationCountrystring+1The international dialing country code for the country in which the promotion is taking place.
messageBodystringComplete SMS message.
messageTypestringAutoresponderThe type of SMS message.
programIdstringP1The ID of the program.
programNamestringProgram 1The name of the program.
programTypestringType 1The program type.
statusCodestringThe delivery status code.
SourcestringList import source.
TagsstringThe 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 NameData TypeExampleDescriptionRequired
campaignNamestringSpring CampaignThe promotional campaign name.
carrierNetworkstringNetworkMobileThe carrier network.
codestring45876A short code or long code used in the message.
descriptionstringDescription of the published event to allow users to understand the event context.
eventIdstring12345Unique ID to identify the type of event and enable lookup in the system.
eventNamestringInteracted SMSShort name for the published event.
locationCountrystring+1The international dialing country code for the country in which the promotion is taking place.
messageBodystringComplete SMS message.
messageTypestringAutoresponderThe type of SMS message.
programIdstringP1The ID of the program.
programNamestringProgram 1The name of the program.
programTypestringType 1The program type.
setConsentstringOpted-inCustomer consent for Opted-in or Opted-out.
SourcestringList import source.
TagsstringThe 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 NameData TypeExampleDescriptionRequired
campaignNamestringSpring CampaignThe campaign name.
carrierNetworkstringNetworkMobile.The carrier network.
codestring45976A short code or long code used in the message.
deliveryStatusstringDeliveredThe delivery status of the SMS (for example, sent, failed, delivered).
descriptionstringA description of the published event to allow users to understand the event context.
eventIdstring12345Unique ID to identify the type of event and enable lookup in the system.
eventNamestringInteracted SMSShort name for the published event.Yes
locationCountrystring+1The international dialing country code for the country in which the promotion is taking place.
messageBodystringComplete SMS message.
messageTypestringAutoresponderThe type of SMS message.
programIdstringProgram 1The name of the program.
programTypestringType 1The program type.
statusCodestringThe delivery status code.
SourcestringList import source.
stepNamestringStep 1The name of the inbound or outbound step.
TagsstringThe 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 NameData TypeExampleDescriptionRequired
eventIdstring12345Unique ID to identify the type of event and enable lookup in the system.
eventNamestringClicked link in SMSShort name for the published event.Yes
descriptionstringA description of the published event to allow users to understand the event context.
mobileNumberstring1-555-555-1234The mobile number that is associated with the event.
programNamestringProgram 1The name of the program.
programIdstringP1The ID of the program.
urlDescriptionstringLink name or description.
clickUrlstringUnpersonalized long URL.
sourcestringList import source.
messageNamestringThe SMS message name.