Description: Batch sending multi content SMS interface.
Parameters | Description | Required | Type |
---|---|---|---|
appId |
App ID (SMS-SMS APP) |
Yes |
String |
array |
Json gather |
Yes |
Array |
numbers |
SMS Receiving Phone Number(COMMA required between each phone number) |
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 |
https://api.onbuka.com/v3/sendSms/batch
RequestURL:
https://api.onbuka.com/v3/sendSms/batch
RequestMethod:
POST
RequestHeaders:
Content-Type: application/json;charset=UTF-8
Sign: 05d7a50893e22a5c4bb3216ae3396c7c
Timestamp: 1630468800
Api-Key: bDqJFiq9
RequestBody:
{
"appId": "4luaKsL2",
"array": [
{
"numbers": "86156584848,86156584848",
"content": "test message",
"senderId": "",
"orderId": "56584,56585"
},
{
"numbers": "86156584848,86156584848",
"content": "test message1",
"senderId": "",
"orderId": "56586,56587"
}
]
}
Parameters | Description | Type |
---|---|---|
status |
"0" means successful,others than 0 means failure, seeing Status code description. |
String |
reason |
failure reason description |
String |
success |
The number of Numbers in the submitted successfully |
String |
fail |
The number of Numbers in the submitted fails |
String |
array |
Json gather |
JSONArray |
msgId |
submitted numbers id corresponding to platform |
String |
number |
submitted numbers |
String |
orderId |
customer id |
String |
Note: After the SMS is successfully submitted and sent, the system will generate a platform msgId for each successfully submitted number. Customers can query the sending results of the number basing on the msgId.
{
"status": "0",
"reason": "success",
"success": "4",
"fail": "0",
"array": [
{
"msgId": "2207201629421000001",
"number": "86156584848",
"orderId": "56584"
},
{
"msgId": "2207201629421000002",
"number": "86156584848",
"orderId": "56585"
},
{
"msgId": "2207201629431000003",
"number": "86156584848",
"orderId": "56586"
},
{
"msgId": "2207201629431000004",
"number": "86156584848",
"orderId": "56587"
}
]
}
Feedback
Need help?
Click here and start chatting with us!