Home Support SMS API

Send File Voice Message

Description: Launch a file voice message via uploaded audio file ID.

Request Parameters Description:

Parameters Description Required Type

callee

Called number: up to 1000 mobile phone numbers. Different mobile phone numbers should be separated by a comma. Each mobile phone number: 7-15 digits composed of national code + mobile phone number.

Yes

String

displayNum

Display number: 7-15 digits or null.

No

String

fileId

Uploaded audio file ID

Yes

String

appId

Audio application ID

Yes

String

maxDuration

Maximum call duration: It will be forced to hang up N seconds after being put through. 1-120 digits or null.

No

Int

maxRingingTime

The maximum ringing duration is 60 by default and can be entered in the range of 20 to 120 seconds.

No

Int

loopCount

Time of loop count: 1-3, by default: 1. Null is allowed.

No

Int

calledInfo

Called information, 0-1000 characters.

No

String

Request URL：

                    
                      https://api.onbuka.com/v3/voice/sendGroup

Request Sample:

                    
                      RequestURL:
                        https://api.onbuka.com/v3/voice/sendGroup
                      RequestMethod:
                        POST
                      RequestHeaders:
                        Content-Type: application/json;charset=UTF-8
                        Sign: 05d7a50893e22a5c4bb3216ae3396c7c
                        Timestamp: 1630468800
                        Api-Key: bDqJFiq9
                      RequestBody:
                        {
                          "callee": "932111111111,932111111112",
                          "displayNum": "1008122211",
                          "fileId": "12022022570cc2484c59d4f8b9745d34226285b1e.mp3",
                          "appId": "4luaKsL2",
                          "maxDuration": 50,
                          "maxRingingTime": 60,
                          "loopCount": 2,
                          "calledInfo": "calledInfo",
                        }

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

data

Submitting result set

JSONArray

voiceId

Exclusive recording ID

String

callee

Called number

String

terminationCode

Submission status: 0 for success, and all others for failure.

String

terminationReason

Status description

String

Response Sample:

                    
                      {
                        "status": "0",
                        "reason": "success",
                        "data": [
                          {
                            "voiceId": "2203031134011000001",
                            "callee": "932111111111",
                            "terminationCode": "0",
                            "terminationReason": "success"
                          },
                          {
                            "voiceId": "2203031134011000002",
                            "callee": "932111111112",
                            "terminationCode": "0",
                            "terminationReason": "success"
                          }
                        ]
                      }
 
Previous Topic: Inquire Audio File
Next Topic: Send TTS Voice Message

Feedback

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

Need help?

Click here and start chatting with us!