Webhooks V1 (GET)
All the types of events and parameters that SMSPortal currently send using Webhooks V1.
When using Webhooks V1, your endpoint must process the received data as a GET request. Your endpoint can be created in any programming language and must be capable of reading data out of a URL, also known as the query string.
Delivery Statuses (DLRs)
The API will push a URL, similar to the following example, to your configured endpoint, containing information about the delivery status for a previously sent SMS.
https://*yourdomain*.com/sentitems.html?ID=322004213&EventID=32433326&Phonenumber=27830123456&DataType=SMS&Data=This+is+sample+text&SentDataTime=1%2FJan%2F2021+14%3A04%3A22&Status=DE-LIVRD&CustomerID=whatever
| Field | Description |
|---|---|
| ID | This is a unique value (integer) for this specific line item |
| EventID | The eventID (long) is the same ID that was provided by the API for the original outgoing SMS batch |
| Phonenumber | The number the message was sent to |
| DataType | ‘SMS’ only |
| Data | The message sent |
| SentDataTime | The status date and time in the format ‘dd/MMM/yyyy HH:mm:ss’ |
| Status | The status that the handset responded with. Please refer to the list of possible delivery statuses here. |
| CustomerID | This is a value that was passed in when you sent your data via the API |
Replies (MOs)
The API will push a URL, similar to the following example, to your configured endpoint, containing information about the reply received for a previously sent SMS.
https://*yourdomains*.com/replyitems.html?IncomingID=123456&Phonenumber=27821234567&IncomingData=Example+reply+message&IncomingDataTime=01%2fJan%2f2021+00%3a00%3a00&SentID=654321&EventID=987654&SentData=Original+outbound+message&SentDataTime=01%2fJan%2f2000+00%3a00%3a00&CustomerID=customerid&Campaign=&SentMessageGRPName=&SentMessageGRPDesc=&NumberValue1=&NumberValue2=&NumberValue3=&NumberValue4=&NumberValue5=&NumberValue6=
| Field | Description |
|---|---|
| IncomingID | This is a unique value (integer) for this specific line item |
| Phonenumber | The number the message was sent to |
| IncomingData | Data received in the reply |
| IncomingDataTime | When the message was received by the server in the format ‘dd/MMM/yyyy HH:mm:ss’ |
| SentID | This is a unique value (long) for this specific outgoing line item |
| EventID | The eventID (long) is the same ID that was provided by the API for the original outgoing SMS batch |
| SentData | The message content sent |
| SentDataTime | The status date and time in the format ‘dd/MMM/yyyy HH:mm:ss’ |
| CustomerID | This optional variable can be an external user supplied reference |
| SentMessageGRPName | The name of the group the data was stored in. This will only be populated if the message was generated from the website |
| SentMessageGRPDesc | The description of the group the data was stored in. This will only be populated if the message was generated from the website |
| NumberValue1 | The Value1 data of the number. This will only be populated if the message was generated from the website. |
| NumberValue2 | The Value2 data of the number. This will only be populated if the message was generated from the website. |
| NumberValue3 | The Value3 data of the number. This will only be populated if the message was generated from the website. |
| NumberValue4 | The Value4 data of the number. This will only be populated if the message was generated from the website. |
| NumberValue5 | The Value5 data of the number. This will only be populated if the message was generated from the website. |
| NumberValue6 | The Value6 data of the number. This will only be populated if the message was generated from the website. |
Short Code Replies
The API will push a URL, similar to the following example, to your configured endpoint, containing information about the shortcode messages that have been received.
https://*yourdomain*.com/shortcodeitems.html?ID=322004213&Message=Example+SC+Message&SC=12345&keyword=MatchedKeyword&mobile=27830123456
| Field | Description |
|---|---|
| ID | The short code message ID |
| Message | The message sent |
| SC | The short code |
| Keyword | The matched keyword |
| Mobile | The mobile number that sent the message |
URL Tracking
The API will push a URL, similar to the following example, to your configured endpoint, containing tracking statistics for each shortened URL in a previously sent SMS.
https://*yourdomain*.com/urlclicks?SentID=3323212332&MsgNumTo=27710000000&CustomerRef=urls0001&Type=REDIRECT
| Field | Description |
|---|---|
| SentID | This is a unique value (integer) for this specific outgoing line item |
| MsgNumTo | The number the message was sent to |
| CustomerRef | This is the "CustomerID" value that was passed in when you sent your data via the API. |
| Type | This will either be "REDIRECT" or "PREVIEW", depending on whether the URL was clicked or previewed. |
Updated 9 days ago