Sign in

v1

latestOpenAPI 3.1.02026-07-24403468.9 KB

Call with User input

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.

post/voice/v1/call

Headers

Authorizationstring

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

Content-Typestring

Request body

tostring required

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

sayTextstring required

The voice message that you want to play during the call

callerVoicestring

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

neuralLangboolean

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

audiofilestring

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

repetitioninteger

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

ringingDurationinteger

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

enabledtmfboolean

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

dtmfCallbackEndpointstring

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

statusCallbackEndpointstring

Register this call back to receive update for each call status once the call start

metadatastring json

Meta-Data is a special purpose field for some integrations

speednumber float

Controls the playback speed of the voice. Accepts one of the following discrete values, ordered from slowest to fastest: 0.5, 0.75, 1.0, 1.25, 1.5. The default speed is 1.0 (normal speed).

isRecordedboolean

Enables call recording. When set to true, recording begins the moment the call is answered by the callee (not while ringing). Defaults to false (no recording).

recordCallbackURLstring

The HTTPS endpoint where the call recording will be delivered once it's ready. After the call ends and the recording is processed, the system sends a callback (webhook) to this URL containing the recording URL. Required when isRecorded is true; ignored otherwise.

Response

200

callIdstring

Example response

{
  "callId": "3863a81a-d1a9-4fb1-a25a-b5ac557ab6ee"
}