Data payloads compared for the FinText (2.0) and Legacy (1.0) platforms
Outbound Message Webhooks
The outbound webhooks send information on outbound message status.
|
FinText 2.0 |
Legacy 1.0 |
Definition |
|
AccountId |
NA |
SBT customer account ID. |
|
BrandId |
NA |
Brand ID number. |
|
Message |
Message |
Text of the outbound message. |
|
Msisdn |
sendTo |
Mobile number with dialing code. Eleven digits with no plus sign (12345678902). |
|
GroupName |
NA |
Name of the messaging group from which the message was sent. |
|
GroupId |
orgcode |
The identifier of the group from which the message was sent. |
|
BrandId |
NA |
The identifier of the brand from which the message was sent. |
|
CommunicationCode |
code |
Short or long code from which the message was sent. |
|
DeliveredTime |
NA |
Time the message was delivered to the handset. |
|
Properties |
UniqueID |
Customer-defined identifier for the message associated with the mobile number. |
|
StatusCode |
status |
Status code for the message. |
|
StatusCodeDescription |
NA |
Status code definition for the message. |
|
MessageId |
ticket |
Message tracking ID number. |
|
ReferenceId |
custom_ticket and note |
Customer-defined identifier for the message. |
|
TotalMessageSegments |
NA |
Number of message segments used by the message. |
|
MessageType |
MessageCategory |
Type of message being sent (Unicast, Multicast, etc.). |
|
Channel |
NA |
Message content type. |
|
Files |
NA |
Media file attached to the message. |
|
NA |
MessageSubcategory |
Extra category information for the message; can be UI, API, HELP, STOP, VBT, or others. |
|
templateId |
TemplateID |
Identifying number of the template used to create the message. |
|
userName |
username |
Name of the sending user in the SBT platform. |
|
NA |
remark |
Internal note added by the sending user. |
Inbound Message Webhooks
The inbound message webhooks send information on messages received from subscribers.
|
FinText 2.0 |
Legacy 1.0 |
Definition |
|
AccountId |
NA |
SBT client account ID. |
|
BrandId |
NA |
The identifier of the brand being polled. |
|
Message |
Title/keyword |
Inbound message content. |
|
OriginalMessage |
Message |
Text of the original message, if the inbound message is a response to a message sent by the SBT platform. |
|
Msisdn |
Phone |
Mobile number with dialing code. Eleven digits with no plus sign (12345678902). |
|
GroupName |
Group |
Name of the messaging group of which the subscriber is a member. |
|
GroupId |
orgcode |
The identifier of the group of which the subscriber is a member. |
|
CommunicationCode |
code/generic_code/shortcode |
Short Code or 10DLC used to send the message. |
|
MessageType |
NA |
Type of message sent. Types: "Stop," "Stopall," "Help," "Keyword," "CustomKeyword," "TwoWay." |
|
ReceivedTime |
NA |
Time the inbound message was received. |
|
Properties |
UniqueID |
Array of objects or null (PropertiesNew) |
|
ReferenceId |
custom_ticket/ note |
Customer-defined identifier for the message. |
|
MessageId |
transactionticket |
Message tracking ID number from SBT. |
|
Files |
NA |
Array of objects or null (MediaFile) |
| totalMessageSegments | NA |
Number of message segments used by the message. |
| Intent | NA |
Statement of purpose as set by the customer. Only appears if a custom keyword is in use. |