API
API

Delivery Status Report

MOY Mobile International Cloud Communication Platform will proactively push SMS delivery status updates to the customer's server. Customers must configure the Delivery Report Webhook URL in the platform console.
When the status of a message changes (e.g., delivered), the platform will send an HTTP POST request to the configured address.

Webhook URL Configuration

Customers need to set the delivery status webhook URL in the console. Example format:

https://your.domain.com/webhook/sms-status

⚠️ Once configured, the URL will be cached for 5 minutes. Changes may take up to 5 minutes to take effect.

Request Method

  • Method: POST
  • Content-Type: application/json
  • Trigger: When the message status changes (e.g., Delivered)

Request Payload Format

The platform will send the following JSON data to the customer's server:

{
  "messageId": "1933051433696038912",
  "accountId": "1910159943521189888",
  "to": "+14155550000",
  "statusCode": "2",
  "statusDescription": "Delivered",
  "receivedAt": "2025-06-12T08:39:14",
  "reference": "reference"
}

Field Descriptions

Field Type Description
messageId string Unique message ID
accountId string Customer account ID
to string Recipient phone number (E.164 format)
statusCode string Delivery status code (see code documentation)
statusDescription string Description of the status (e.g., Delivered)
receivedAt string Time the status was received by the platform (UTC ISO 8601 format)
reference string The reference field provided by the customer when sending message

Response Requirements

The customer server should return HTTP 200 to acknowledge successful receipt.
⚠️ The platform does not support automatic retries. Please ensure high availability of your webhook service.

Example

Sample Request from Platform

POST /webhook/sms-status HTTP/1.1
Host: your.domain.com
Content-Type: application/json

{
  "messageId": "1933051433696038912",
  "accountId": "1910159943521189888",
  "to": "+14155550000",
  "statusCode": "2",
  "statusDescription": "Delivered",
  "receivedAt": "2025-06-12T08:39:14",
  "reference": "reference"
}

Expected Response from Customer

HTTP/1.1 200 OK

To test if your webhook is configured correctly, use the testing tool provided by the platform or contact technical support.
Support Email: [email protected]

ON THIS Page