Home Support SMS API

Get SMS Report by Time Slot

Description: The protocol is used to get SMS report by time slot(Support the query of SMS records in the last 90 days, with the maximum query time interval of 31 days).

Request Parameters Description：

Parameters Description Required Type

appId

App ID (SMS-SMS APP)

Yes

String

startTime

Beginning time of query, ISO8601 standard time format UrlEncode(2021-02-12T00:00:00+08:00)

Yes

String

endTime

Ending time of query, ISO8601 standard time format UrlEncode(2021-02-12T23:59:59+08:00)

Yes

String

startIndex

The starting subscript of the query ( Max 50,000 results can be returned by one query as default. This function and be used for multiple queries when results over 50,000)

No（Default 0）

Int

Request URL：

                    
                      https://api.onbuka.com/v3/getSentRcd?appId={appId}&startTime={startTime}&endTime={endTime}&startIndex={startIndex}

Request Sample:

                    
                      RequestURL:
                        https://api.onbuka.com/v3/getSentRcd?appId=4luaKsL2&startTime=2021-02-12T00%3A00%3A00%2B08%3A00&endTime=2021-02-12T23%3A59%3A59%2B08%3A00&startIndex=0
                      RequestMethod:
                        GET
                      RequestHeaders:
                        Content-Type:application/json;charset=UTF-8
                        Sign:05d7a50893e22a5c4bb3216ae3396c7c
                        Timestamp:1630468800
                        Api-Key:bDqJFiq9

Response Parameters Description：

Parameters Description Type

status

"0"means successful, others than 0 means failure, seeing Status code description.

String

reason

Failure reason description

String

success

Number of successful submitted messages

String

fail

Number of failure submitted messages

String

array

Json array with submission results

JSONArray

msgId

Submitted numbers id corresponding to platform

String

number

Submitted numbers

String

receiveTime

Receive time ISO8601 standard tine format (2021-02-12T09:30:03+08:00)

String

status

Messages status: 0:sent successfully, 2:sent failed

String

Response Sample:

                    
                      {
                        "status": "0",
                        "reason": "success",
                        "success": "2",
                        "fail": "0",
                        "array": [
                          {
                            "msgId": "2108021054011000095",
                            "number": "91856321412",
                            "receiveTime": "2021-02-12T09:30:03+08:00",
                            "status": "0"
                          },
                          {
                            "msgId": "2108021059531000096",
                            "number": "91856321413",
                            "receiveTime": "2021-02-12T09:30:03+08:00",
                            "status": "0"
                          }
                        ]
                      }
 
Previous Topic: Get Report
Next Topic: Batch Sending Multi Content SMS

Feedback

0/500
✖
Service Support
1. Requirements Type
2. Requirements Description
3. Email

Need help?

Click here and start chatting with us!