SMS Delivery Status Query

SMS Delivery Status Query

Request URL

https://{domain}/sms/state?spid=xx&pwd=xx&timestamp=xx&msgid=xx

Request Method

GET

Parameter Description

Field	Type	Name	Description
spid	string	Interface account
pwd	string	Password	Important note 3
timestamp	string	Current Unix timestamp (seconds)	Example: 1601028870
msgid	string	Message ID (no more than 100 per request)	For multiple IDs, connect with commas, e.g.,100123,100124

Response

{
  "code": 0,
  "msg": "Success",
  "data": [{
    "msgid": "100123",
    "state": 0
  }]
}

Delivery Status Description

state 0-No receipt (submitted to channel), 1-Delivery success, 2-Delivery failure

Asynchronous Delivery Notification

Interface Description

After the channel returns a receipt, notify the client of SMS delivery content through the configured URL. If needed, inform us of the URL for configuration.

Request URL

http(s)://{your_callback_url}?msgid=36160109669&das=628131565746&state=1

Request Method

GET

Parameter Description

• msgid Message ID
• state 0-No receipt (submitted to channel), 1-Delivery success, 2-Delivery failure

Report SMS Status

Interface Description

Client business platform SMS status statistics within a specific time period (start_time~end_time) for monitoring and problem detection

Request URL

https://{domain}/sms/monitor

Request Method

POST Content-Type: application/x-www-form-urlencoded

Parameter Description

Field	Type	Name	Description
spid	string	Interface account
start_time	string	Start time Unix timestamp (seconds)	Data statistics start time, example: 1601028870
end_time	string	End time Unix timestamp (seconds)	Data statistics end time, example: 1601028870
total	int	Total submission records
success	int	Number of successful status

Response

{
  "code": 0,
  "msg": "Success"
}