Home Support SMS API

Sending Messages

Description: The protocol is used to send SMS, supporting single number or multiple numbers, Support GET or POST, GET can support 100 numbers once, POST can support 1000 numbers once.

Request Parameters Description:

Parameters Description Required Type

appId

App ID (Account Management – App Management -appId properties)

Yes

String

numbers

Receiving number, multiple numbers should be separated with comma GET can support 100 numbers once, POST can support 1000 numbers once）

Yes

String

content

SMS content，length should not be over the 1024 characters.(GET should use urlEncode）

Yes

String

senderId

Sender number(name). The maximum length is 32 characters.

No

String

orderId

Customer message id. The number of orderId must be consistent with the number of mobile phone numbers.

No

String

Request URL:

                    
                      https://api.onbuka.com/v3/sendSms

Sample:use GET Request to send content “hello world”：

                    
                      RequestURL:
                        https://api.onbuka.com/v3/sendSms?appId=4luaKsL2&numbers=91856321412,91856321413&content=hello%20world&senderId=123&orderId=21412,21413
                      RequestMethod:
                        GET
                      RequestHeaders:
                        Content-Type:application/json;charset=UTF-8
                        Sign:05d7a50893e22a5c4bb3216ae3396c7c
                        Timestamp:1630468800
                        Api-Key:bDqJFiq9

Sample:use POST Request to send content “hello world”：

                    
                      RequestURL:
                        https://api.onbuka.com/v3/sendSms
                      RequestMethod:
                        POST 
                      RequestHeaders:
                        Content-Type: application/json;charset=UTF-8
                        Sign: 05d7a50893e22a5c4bb3216ae3396c7c
                        Timestamp: 1630468800
                        Api-Key: bDqJFiq9
                      RequestBody:
                        {
                          "appId": "4luaKsL2",
                          "numbers": "91856321412,91856321413",
                          "content": "helloworld",
                          "senderId": "123",
                          "orderId":"21412,21413"
                        }

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 numbers

String

fail

Number of failure submitted numbers

String

array

The number of Successful Submitted Array.

JSONArray

msgId

Submitted numbers id corresponding to platform

String

number

Submitted numbers

String

orderId

Custom message ID

String

Response Sample:

                    
                      {
                        "status": "0",
                        "reason": "success",
                        "success": "2",
                        "fail": "0",
                        "array":[
                          {
                            "msgId": "2108021054011000095",
                            "number": "91856321412",
                            "orderId": "21412"
                          },
                          {
                            "msgId": "2108021059531000096",
                            "number": "91856321413",
                            "orderId": "21413"
                          }
                        ]
                      }
 
Previous Topic: Balance Query
Next Topic: Get Report

Feedback

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

Need help?

Click here and start chatting with us!