SMS event types are: Interacted with an SMS Program, Been Sent a Message from SMS Program, Interacted with a Multi-step Program, Received Delivery Status, and Clicked Link in SMS. You can view a list of SMS event types and their parameters below.
Event type name: Interacted with an SMS Program
Event type code: 54
This event is triggered for messages sent from a contact's mobile device, also known as Mobile Originated (MO) messages. This event is not triggered with multi-step SMS programs.
Note: Tags are only supported for organizations that are set up to send SMS via the Exchange sender mechanism. The Tags attribute is listed under several of the UBs on this page.
Event 54 is published each time a list of SMS contacts is imported through the UI or imported using the API. However, you can choose not to publish Event 54 by clearing the Publish 'Interacted with an SMS Program' event when importing SMS contacts check box in the Mobile Settings.
|
UB attribute |
Exchange attribute |
Data type |
Valid values |
|
Mobile Number |
mobileNumber |
Short text |
|
|
Campaign Name |
campaignName |
Short text |
|
|
Program Id |
smsProgramId |
Short text |
|
|
Program Name |
smsProgramName |
Short text |
|
|
Program Type |
smsProgramType |
Short text |
|
|
Country |
locationCountry |
Short text |
|
|
Code |
code |
Short text |
|
|
Message Body |
messageBody |
Short text |
|
|
Message Type |
messageType |
Short text |
|
|
Carrier Network |
carrierNetwork |
Short text |
|
|
Source |
source |
Short text |
|
|
Tags |
tags |
Long Text |
|
|
Set Consent |
setConsent |
Short text |
|
Event type name: Been Sent a Message from SMS Program (smsSent)
Event type code: 55
This event is triggered for messages that are sent to a contact's mobile device, also known as Mobile Terminated (MT) messages. This event is not triggered with Multi-step SMS programs.
|
UB attribute |
Exchange attribute |
Data type |
Valid values |
|
Mobile Number |
mobileNumber |
Short text |
{Mobile Number} |
|
Campaign Name |
campaignName |
Short text |
{Campaign Name} |
|
Program Id |
smsProgramId |
Short text |
{Program Id} |
|
Program Name |
smsProgramName |
Short text |
{Program Name} |
|
Program Type |
smsProgramType |
Short text |
|
|
Country |
locationCountry |
Short text |
|
|
Code |
code |
Short text |
{Short / Long Code} |
|
Message Body |
messageBody |
Short text |
|
|
Message Type |
messageType |
Short text |
|
|
Carrier Network |
carrierNetwork |
Short text |
{Carrier Network} |
|
Source |
source |
Short text |
{null} |
|
Tags |
tags |
Long text |
|
Event type name: Interacted with a Multi Step Program
Event type code: 61
This event is triggered when an incoming SMS is received initially to start the multi-step program. Once a given multi-step program is started, for each incoming SMS, a new UB #61 will not be triggered.
|
Attribute |
Data type |
Valid values |
|
Mobile Number |
Short text |
{Mobile Number} |
|
Campaign Name |
Short text |
{Campaign Name} |
|
Program Name |
Short text |
{Program Name} |
|
Program Type |
Short text |
Multi-Step |
|
Country |
Short text |
|
|
Code |
Short text |
{Short / Long Code} |
|
Step Name |
Short text |
{Name of the inbound or outbound step} |
|
Message Body |
Short text |
{Message Body} |
|
Message Type |
Short text |
|
Event type name: Received Delivery Status
This event is triggered for every MT message, except for those sent with a multi-step SMS program. When an SMS message leaves the SMS gateway, Delivery Status is populated with Sent. When received from the carrier, Delivery Status is updated to Delivered or Failed. Not all carriers provide delivery status; when Delivery Status is not provided it remains as Sent.
|
Attribute |
Data type |
Valid values |
|
Mobile Number |
Short text |
{Mobile Number} |
|
Campaign Name |
Short text |
{Campaign Name} |
|
Program Name |
Short text |
{Program Name} |
|
Program Id |
Numeric |
{Id of the Program} |
|
Program Type |
Short text |
|
|
Country |
Short text |
|
|
Code |
Short text |
{Short / Long Code} |
|
Message Body |
Short text |
|
|
Message Type |
Short text |
|
|
Carrier Network |
Short text |
{Carrier Network} |
|
Tags |
Long text |
|
|
Source |
Short text |
{Source parameter Value from Batch SMS Send API} Example Value: {mailingId=34,reportId=234,recipientId=234,jobId=433} |
|
Delivery Status |
Short text |
|
|
Status Code |
Short text |
{Failed Status Code} Only populated when delivery Status is 'Failed'. For example:
|
Event type name: Clicked Link in SMS
This event is triggered when a contact clicks a link in an SMS message. This event is only available when the SMS Link Tracking feature is enabled.
|
Attribute |
Data type |
Valid values |
|
Mobile Number |
Short text |
{Mobile Number} |
|
Program Name |
Short text |
{SMS Program Name} |
|
Program Id |
Numeric |
{Id of the SMS Program} |
|
Link Name |
Short text |
{Link Name} |
|
Link URL |
Short text |
Unpersonalized long url Example: http://golfsmith.com/carbonfiber/?fname=%%fname%% |
|
Source |
Short text |
{mailingId=34,reportId=234,recipientId=234,jobId=433} |
|
Message Name |
Short text |
{SMS message name} |
Comments
0 comments
Article is closed for comments.