Home Support SMS API

Get Report

Description: The protocol is used to query the submission result of specific msgId array(From beginning time to ending time, only the SMS records of the last 90-120 days can be queried)

Request Parameters Description:

Parameters Description Required Type

appId

App ID (SMS-SMS APP)

Yes

String

msgIds

Platform id returned by sendsms protocol response. multiple id should be separated with comma. 200 msgId query can be supported once.

Yes

String

Request URL:

                    
                      https://api.onbuka.com/v3/getReport?appId={appId}&msgIds={msgIds}

Request Sample:

                    
                      RequestURL:
                        https://api.onbuka.com/v3/getReport?appId=4luaKsL2&msgIds=2108021054011000095,2108021059531000096
                      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

sending

Number of sending messages

String

nofound

The number of nofound messages by ID(Contains SMS messages in the queue)

String

array

Json array with submission results

JSONArray

msgId

Submitted numbers id corresponding to platform

String

number

Submitted nunbers

String

receiveTime

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

String

status

Messages status：0: sent successfully, -1：sent in, 1：sent failed(Does not contain messages in the queue)

String

pricedetail

Fee details

JSONObject

pay

Total cost

String

chargeCnt

Number of billing entries

Int

currency

Currency

String

price

Unit

String

settleCurrency

Settlement currency. This field is returned when the quoted currency is not USD.

String

settlePrice

Unit price of settlement currency. This field is returned when the quoted currency is not USD.

String

quoteExchange

Quote exchange rate. This field is returned when the quoted currency is not USD.

String

settlePay

Total fees in settlement currency. This field is returned when the quoted currency is not USD.

String

Response Sample:

                  
                    {
                      "status": "0",
                      "reason": "success",
                      "success": "2",
                      "fail": "0",
                      "sending": "0",
                      "nofound": "0",
                      "array": [
                        {
                          "msgId": "2108021054011000095",
                          "number": "91856321412",
                          "receiveTime": "2021-02-12T09:30:03+08:00",
                          "status": "0",
                          "pricedetail":{
                            "pay":"0.02",
                            "currency":"USD",
                            "chargeCnt":2,
                            "price":"0.01"
                          }
                        },
                        {
                          "msgId": "2108021059531000096",
                          "number": "91856321413",
                          "receiveTime": "2021-02-12T09:30:03+08:00",
                          "status": "0",
                          "pricedetail":{
                            "pay":"0.02",
                            "currency":"USD",
                            "chargeCnt":2,
                            "price":"0.01",
                            "quoteExchange": "0.914608",
                            "settlePay": "1.674386",
                            "settleCurrency": "usD",
                            "settlePrice": "1.674386",
                            "currency": "EUR"
                          }
                        }
                      ]
                    }
 

Feedback

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

Need help?

Click here and start chatting with us!