After activating this interface function, the server will delete the current successfully pulled data and no longer save it! Please store it in a timely manner. This status report is saved for 72 hours, with a maximum storage capacity of 1 million entries.
Note: This interface is not open by default. Please contact customer service to enable it.
REQUEST
| NAME | DESCRIBE | 
|---|---|
| Request Protocol | HTTP POST | 
| Encoding Format | UTF8 | 
| Content-Type | application/json | 
| URL(Singapore) | http://intapi.sgap.253.com/pull/report | 
| URL(Shanghai) | https://intapi.253.com/pull/report | 
Attention: Please request the corresponding URL based on the node where the account is located, otherwise the query will be inaccurate.
Parameter Description
| NAME | TYPE | REQUIRES | DESCRIBE | EXAMPLE | 
|---|---|---|---|---|
| account | string | YES | API account | "account":"IM9000001" | 
| password | string | YES | API password (8-16 bits) | "password":"ABCdef15301" | 
| count | integer | YES | Pulling quantity (upper limit of 100, default to 20) | "count":"20" | 
Request Example
{
  "account":"IM6000001",
  "password":"123456",
  "count":"20"
}Response
Parameter Description
| NAME | TYPE | DESCRIBE | EXAMPLE | 
|---|---|---|---|
| result | string | Status details result, if there is no result, return an empty array | "result":[{ XXX:XXX }] | 
| batchSeq | string | Batch number | I123645_2402010011_4450868 | 
| requestTime | string | The submission time for SMS is within 24 hours in mainland China. Format: yyMMddHHmmss | "requestTime":"240201171455" | 
| notifyTime | string | The time when we pushed the status report. Format: yyMMddHHmmss | "notifyTime":"240201171458" | 
| fee | string | Deduction amount, currency RMB | "fee":"0.5" | 
| mobile | string | The phone number for receiving text messages | "mobile":"008613900001111" | 
| msgid | string | The msgid of the interface response when submitting a text message | "msgid":"447863149849481216" | 
| reportTime | string | Status update time, format yyMMddHHmm, where yy=last two digits of the year (00-99) | "reportTime":"1706778840000" | 
| status | string | The status returned by the operator (refer to common status report status codes for details) | "status":"DELIVRD" | 
| smsNum | string | Number of billing items | "smsNum":"1" | 
Response example
{
    "result":[
        {
            "batchSeq": "I1266966_2402011714_1786015",
            "requestTime": "240201171455",
            "notifyTime": "240201171458",
            "fee": "0.2826",
            "mobile": "008413908446911",
            "msgid": "447863149849481216",
            "reportTime": "1706778840000",
            "status": "FAILED",
            "smsNum": "1"
        }
    ],
    "code":0,
    "error":""
}