Home Support SMS API

Send TTS Voice Message

Description: Send TTS voice message via designated language and designated language text.

Request Parameters Description:

Parameters Description Required Type

callee

Called number: 7-15 digits composed of national code + mobile phone number.

Yes

String

displayNum

Display number: 7-15 digits or null.

No

String

language

Language code, please refer to the table below for language details.

Yes

String

speakingRate

Speech speed: 0.25 - 4 times

No

Double

ssmlGender

Voice: 1 male 2 female. Allowed to be empty. When there are multiple voices, the system uses female voice by default.

No

Integer

accent

Accent: You can configure language accents, such as English [American Accent], English [Indian Accent], etc. For accent details, please refer to the table below.

No

String

text

Text content, length 1000

Yes

String

appId

Audio application ID

Yes

String

loopCount

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

No

Int

recallCount

Recall times, 0-9 numbers, the field can be left blank. if not filled in, the default value is 0, and the recall function is not enabled when it is equal to 0.

No

Int

recallInterval

Recall interval, 1-999 numbers, in minutes. This field is only valid when the number of recalls is greater than 0. The field can be empty. When the field is empty, the default value is 5.

No

Int

maxDuration

Maximum call duration, forced hang up after N seconds after the call is connected, 1-120 numbers, can be empty.

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

calledInfo

Called information, 0-1000 characters.

No

String

Request URL:

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

Request Sample:

                    
                      RequestURL:
                        https://api.onbuka.com/v3/voice/sendCode
                      RequestMethod:
                        POST
                      RequestHeaders:
                        Content-Type: application/json;charset=UTF-8
                        Sign: 05d7a50893e22a5c4bb3216ae3396c7c
                        Timestamp: 1630468800
                        Api-Key: bDqJFiq9
                      RequestBody:
                        {
                          "callee": "932111111111",
                          "displayNum": "1008122211",
                          "language": "EN",
                          "accent":"91",
                          "ssmlGender":2,
                          "speakingRate":1,
                          "text": "helloworld",
                          "appId": "4luaKsL2",
                          "loopCount": 2,
                          "recallCount":0,
                          "recallInterval":0,
                          "maxDuration":120,
                          "maxRingingTime":60,
                          "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

Exclusive recording ID

String

Response Sample:

                    
                      {
                        "status": "0",
                        "reason": "success",
                        "data": "2203031113381000002"
                      }
                    
                  

Language, Accent and Timbre Relationship Table:

Language Accent Timbre

Arabic (AR)

-

Male Voice: 1
Female Voice: 2

Bask (BAS)

Spain (34)

Male Voice:-
Female Voice: 2

Catalan (CA)

Male Voice:-
Female Voice: 2

Galician (GL)

Male Voice:-
Female Voice: 2

Bengali (BN)

India (91)

Male Voice: 1
Female Voice: 2

Gujarati (GU)

Male Voice: 1
Female Voice: 2

Hindi (HI)

Male Voice: 1
Female Voice: 2

Kannada (KN)

Male Voice: 1
Female Voice: 2

Malayalam (ML)

Male Voice: 1
Female Voice: 2

Marathi (MR)

Male Voice: 1
Female Voice: 2

Punjabi (PA)

Male Voice: 1
Female Voice: 2

Tamil (TA)

Male Voice: 1
Female Voice: 2

Bulgarian (BG)

Bulgaria (359)

Male Voice:-
Female Voice: 2

Czech (CS)

Czech Republic (420)

Male Voice:-
Female Voice: 2

Danish (DA)

Denmark (45)

Male Voice: 1
Female Voice: 2

Dutch (NL)

Netherlands (31) [default accent]

Male Voice: 1
Female Voice: 2

Belgium (32)

Male Voice: 1
Female Voice: 2

English (EN)

India (91)

Male Voice: 1
Female Voice: 2

US (1) [Default Accent]

Male Voice: 1
Female Voice: 2

United Kingdom (44)

Male Voice: 1
Female Voice: 2

Australia (61)

Male Voice: 1
Female Voice: 2

Filipino (TL)

Philippines (63)

Male Voice: 1
Female Voice: 2

Finnish (FI)

Finland (358)

Male Voice:-
Female Voice: 2

French (FR)

French (33) [default accent]

Male Voice: 1
Female Voice: 2

Canada (1)

Male Voice: 1
Female Voice: 2

German (DE)

Germany (49)

Male Voice: 1
Female Voice: 2

Greek (EL)

Greece (30)

Male Voice:-
Female Voice: 2

Hebrew (HE)

Israel (972)

Male Voice: 1
Female Voice: 2

Hungarian (HU)

Hungary (36)

Male Voice:-
Female Voice: 2

Icelandic (IS)

Iceland (354)

Male Voice:-
Female Voice: 2

Indonesian (ID)

Indonesia (62)

Male Voice: 1
Female Voice: 2

Italian (IT)

Italy (39)

Male Voice: 1
Female Voice: 2

Japanese (JA)

Japan (81)

Male Voice: 1
Female Voice: 2

Korean (KO)

South Korea (82)

Male Voice: 1
Female Voice: 2

Latvian (LV)

Latvia (371)

Male Voice: 1
Female Voice:-

Lithuanian (LT)

Lithuania (370)

Male Voice: 1
Female Voice:-

Malay (MS)

Malaysia (60)

Male Voice: 1
Female Voice: 2

Norwegian (NO)

Norway (47)

Male Voice: 1
Female Voice: 2

Polish (PL)

Poland (48)

Male Voice: 1
Female Voice: 2

Portuguese (PT)

Brazil (55)

Male Voice: 1
Female Voice: 2

Portugal (351) [default accent]

Male Voice: 1
Female Voice: 2

Romanian (RO)

Romania (40)

Male Voice:-
Female Voice: 2

Russian (RU)

Russia (7)

Male Voice: 1
Female Voice: 2

Serbian (RS)

Serbia (381)

Male Voice:-
Female Voice: 2

Slovak (SK)

Slovakia (421)

Male Voice:-
Female Voice: 2

Spanish (ES)

Spain (34) [Default accent]

Male Voice: 1
Female Voice: 2

United States (1)

Male Voice: 1
Female Voice: 2

Swedish (SV)

Sweden (46)

Male Voice: 1
Female Voice: 2

Thai (TH)

Thailand (66)

Male Voice:-
Female Voice: 2

Turkish (TR)

Turkey (90)

Male Voice: 1
Female Voice: 2

Vietnamese (VI)

Vietnam (84)

Male Voice: 1
Female Voice: 2

Afrikaans (AF)

South Africa (27)

Male Voice:-
Female Voice: 2

 

Previous Topic: Send File Voice Message
Next Topic: Invoke Phone

Feedback

0/500

Need help?

Click here and start chatting with us!