Call with User input

post

https://apis.cequens.com/voice/v1/call

This API endpoint allows users to initiate a voice call to a mobile number, during which a voice message will be played. Users can specify the voice message using either the Text-to-Speech (TTS) or the audio file URL. Additionally, the API enables DTMF input collection, allowing the call recipient to press a key on their handset to provide input.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

required

Defaults to XX-XXX-XXXXXXX

The mobile number in numbering plan format E.164 that you want to send the call to

sayText

string

required

Defaults to Welcome to cequens voice AIPs

The voice message that you want to play during the call

callerVoice

string

Defaults to Zeina

TTS Voices https://docs.aws.amazon.com/polly/latest/dg/voicelist.html

neuralLang

boolean

Defaults to false

Neural TTS that can produce even higher quality voices than its standard voices

audiofile

string

Defaults to http://localhost/test.wav

The URL of the audio file to be played during the call.

repetition

int32

Defaults to 2

The number of repeats that you would like to make during the call for the sayText field

ringingDuration

int32

Defaults to 30

Timeout seconds number to wait for the channel to be answered before giving up

enabledtmf

boolean

Defaults to false

If you want to collect back input from the user handset "i.e. press 1 to do something .." , in this case we suppose the field dtmfCallbackEndpoint to be refer for your own callback endpoint

dtmfCallbackEndpoint

string

Defaults to "http://localhost:9001/my_call_id/dtmf

Http Get callback endpiont for the collected user input during the call "overall"

statusCallbackEndpoint

string

Defaults to http://localhost:9001/my_call_id/status

metadata

json

Defaults to { "key": "kay01", "value": "value01" }

Meta-Data is a special purpose field for some integrations

Headers

Authorization

string

Defaults to Bearer Your_Token_From_Login_Step

Authorization header bearer with the token returned from sign-in step

Content-Type

string

Defaults to application/json

Responses

200200

401401

403403

404404