create a call

POST

Path parameters

AccountSidstringRequired

Request

This endpoint expects an object.
fromstringRequired

The calling party number

toobjectRequired

Destination for call

application_sidstringOptionalformat: "uuid"

The application to use to control this call. Either applicationSid or url is required.

answerOnBridgebooleanOptional

If set to true, the inbound call will ring until the number that was dialed answers the call, and at that point a 200 OK will be sent on the inbound leg. If false, the inbound call will be answered immediately as the outbound call is placed.

call_hookobjectOptional
call_status_hookobjectOptional
fromHoststringOptional

The hostname to put in the SIP From header of the INVITE

timeoutintegerOptional

The number of seconds to wait for call to be answered. Defaults to 60.

timeLimitintegerOptional

The max length of call in seconds

tagmap from strings to anyOptional

Initial set of customer-supplied metadata to associate with the call (see jambonz ‘tag’ verb)

headersmap from strings to anyOptional

The customer SIP headers to associate with the call

sipRequestWithinDialogHookstringOptional

The sip indialog hook to receive session messages

speech_synthesis_vendorstringOptional

The vendor for Text to Speech (required if application_sid is not used)

speech_synthesis_languagestringOptional

The language for Text to Speech (required if application_sid is not used)

speech_synthesis_voicestringOptional

The voice for Text to Speech (required if application_sid is not used)

speech_recognizer_vendorstringOptional

The vendor for Speech to Text (required if application_sid is not used)

speech_recognizer_languagestringOptional

The language for Speech to Text (required if application_sid is not used)

Response

call successfully created

sidstringformat: "uuid"

Errors

Built with