Our SMS delivery service offers HTTP POST method for sending text messages. These messages should be encoded in UTF-8 format.Upon receiving a send request through our X Lead platform, we promptly issue a reference id. This immediate feedback serves as an acknowledgment to your system, confirming that we have successfully received the request and queued it for processing.After processing, we will provide the status of your request through your callback URL. The response may indicate a valid send with the corresponding number of points to deduct, or it may be an invalid submission due to reasons such as insufficient points, an invalid mobile number, or the number being on the do-not-call list.Once the message has been submitted to the corresponding telecommunications operator, our service extends an additional callback feature. This focuses on the response from the recipient's handheld device. Once the telecommunications operator receives a delivery status from the recipient's device, we relay this information back to you through your callback URL, and this is crucial for understanding the success rate of your sent messages and for troubleshooting any issues related to message delivery.Our system is designed to keep you thoroughly informed throughout the entire process. From the moment your message is dispatched from our platform, we ensure that each step is communicated back to you for effective tracking.Here is the complete flow of the delivery and report operation.
Callback URL is the URL you provided to us (setup in dashboard) in order to listen to our updates in below format :| Field | Description |
|---|
| rc | return code |
| rm | return message with detail explanation, if any |
| ref_id | reference id that we returned during your original API call |
| status | submission or delivery status of your API request |
There are 2 tiers of callbacks :#
1st Callback (Send Request Report)
rc = 100 (message will be charged)| Status | Description |
|---|
| SMD | A valid send, message has been submitted to carrier for delivery |
In the event of a failure (rc = -100), you may encounter the following scenarios with corresponding status.rc = -100 (message will not be charged)| Status | Description |
|---|
| IM | Incorrect country code or mobile |
| OFCA | In OFCA DNC and filtered (HK only) |
| IUL | In unsend list, message did not send out |
| IP | Insufficient points |
| IS | Invalid sender, or sender id is not registered in your account |
2nd Callback (Delivery Report)
| Status | Description |
|---|
| DELIVRD | carrier has successfully delivered to the recipient's device |
| EXPIRED | message is not delivered as processing exceeded the validity period |
| UNDELIV | undelivered due to unreachable destination, network issues, or recipient's device being turned off |
| REJECTD | rejected due to invalid content, blacklisted, or policy restrictions |
| UNKNWN | carrier cannot determine the final delivery status of the message |
You must first log into your account dashboard and set up this Callback URL in order to receive our status update of messages delivery.
