Query-Report API

Query SMS deliver status sent in 14 days.

Request

HTTP Method

GET

URL

http(s)://comm.botion.com/query_report

Header parameters

Parameter	Value	Required	Description
Authorization	account_id=xp9mzzxttrrjheg8jtojwskqzz64zq3j,nonce=ui8ghc9nhz4rosqnp8f2ey2fbeb1smog,signature=8b753bc5b5cd1bc58b4bbee2f1f88f6cbfbe66839eb9c57a4b6b9056cc439902,timestamp=1664161826	Yes	See Authorization Header

Request query parameters

URL Encode

Query parameters need to be encoded using URL encode, for example "+" will be encoded as "%2B"

Parameter	Required	Type	Value Sample	Description
trade_id	Yes	string	7ee689b8b83ecf076d96bc35406123d3	trade_id in Send-SMS API response
phone	Yes	string	+85264****92	phone number, remember to use URL encode

Example of request query parameters:

?phone=%2B85264****92&trade_id=67f91c53cc3744edad2190866d2f****

Response

Example of response body:

 // Success
{
    "data": {
        "query_trade_id": "67f91c53cc3744edad2190866d2f****",
        "send_time": 1679382346,  // sms send timestamp
        "recv_time": 1679382352,  // sms receive timestamp
        "deliver_status": "DELIVRD",  // sms deliver status, "DELIVRD" means that the message delivered to the user, and others are the reasons for not delivered
        "phone": "+85264****92"
    },
    "status": 200,
    "trade_id": "7ee689b8b83ecf076d96bc35406123d3"
}

// Failed
{
    "data": "",
    "status": 1400,
    "trade_id": "ee583aa78b8b61114ece3fdedc2cac90",
    "error_msg": "deliver status not found"
}