The SMS notification data represents all SMS notification events triggered by MyDataHelps. For all of the SMS notification events, a record can be uniquely identified 99% of the time using ParticipantID (or ParticipantIdentifier) plus Timestamp plus NotificationIdentifier.
Table of Contents
SMS Notification Send, Delivery, Opt Out, & Failure
The SMS Notification Send, Delivery, Opt Out, and Failure files contains the following fields:
| Field | Description |
|---|---|
ParticipantID |
The stable, automatically generated, internal system identifier for this participant. |
ParticipantIdentifier |
The identifier of the participant the notification or survey was delivered to. Can be used to cross reference with Participants. |
NotificationIdentifier |
The organization-specific identifier of the notification that was sent. This is the identifier shown in the Notifications library. |
SmsEventKey |
A unique key for the SMS event. |
MessageID |
The unique ID generated when the message is accepted by the system. |
Timestamp |
The timestamp of when the SMS notification was sent, in UTC. |
MessageTimestamp |
The timestamp of when the event was received by the system, in UTC. |
DestinationPhoneNumber |
Phone number to which the SMS was sent. |
OriginationPhoneNumber |
Phone number from which the SMS was sent. |
RecordStatus |
Status of the SMS event, e.g. "Successful". |
NumberOfMessageParts |
Number of message parts sent out as part of the message.
Generally, SMS messages can contain only 160 GSM-7 characters or 67 non-GSM characters, although these limits can vary by country. If you send a message that exceeds these limits, the message is automatically split into smaller parts. |
MessageType |
The type of message. Possible values are "Promotional" and "Transactional". Generally will be "Transactional" as participants have opted into your project. |
MCCMNC |
Mobile Country Codes (MCC) and Mobile Network Codes (MNC), identifying the country of the SMS receipient. |
SMS Notification Link Clicked
The SMS Notification Link Clicked file contains the following fields.
| Field | Description |
|---|---|
ParticipantID |
The stable, automatically generated, internal system identifier for this participant. |
ParticipantIdentifier |
The identifier of the participant the notification or survey was delivered to. Can be used to cross reference with Participants. |
Timestamp |
The timestamp of when the SMS notification link was clicked, in UTC. |
NotificationIdentifier |
The organization-specific identifier of the notification that was sent. This is the identifier shown in the Notifications library. |
TargetURL |
The URL within the notification that was clicked. |
[Legacy] SMS Notification Sent
The SMS Notification Sent export is a legacy export and we recommend using the other SMS Notification Exports above.
The SMS Notification Sent file contains the following fields.
| Field | Description |
|---|---|
ParticipantID |
The stable, automatically generated, internal system identifier for this participant. |
ParticipantIdentifier |
The identifier of the participant the notification or survey was delivered to. Can be used to cross reference with Participants. |
Timestamp |
The timestamp of when the SMS notification was sent, in UTC. |
Message |
The text of the SMS message. |
NotificationIdentifier |
The organization-specific identifier of the notification that was sent. This is the identifier shown in the Notifications library. |
To |
The phone number that the SMS notification was sent to. |
Sample CSV Export
ParticipantIdentifier,Timestamp,ParticipantID,SmsEventKey,MessageID,NotificationIdentifier,MessageTimestamp,DestinationPhoneNumber,OriginationPhoneNumber,RecordStatus,MCCMNC,NumberOfMessageParts,MessageType
MDH-008,2022-06-13T20:07:43Z,5e4e4958-6812-ec11-aab0-0afb9334277d,49630106908387572488188190533472574108174215181487833090000000,gp2a7g2jmp7argv8rodd635hg6maodig7lse4do0,valentine-test-notification-2,2022-06-13T20:07:42Z,+17344172047,+19382231360,SUCCESSFUL,311489,1,TransactionalSample JSON Export
{
"ParticipantIdentifier": "MDH-008",
"Timestamp": "2022-06-13T20:07:43Z",
"ParticipantID": "5e4e4958-6812-ec11-aab0-0afb9334277d",
"SmsEventKey": "49630106908387572488188190533472574108174215181487833090000000",
"MessageID": "gp2a7g2jmp7argv8rodd635hg6maodig7lse4do0",
"NotificationIdentifier": "test-notification",
"MessageTimestamp": "2022-06-13T20:07:42Z",
"DestinationPhoneNumber": "+11234567890",
"OriginationPhoneNumber": "+19876543210,
"RecordStatus": "SUCCESSFUL",
"MCCMNC": "311489",
"NumberOfMessageParts": "1",
"MessageType": "Transactional"
}