Skip to navigation
REST Call ControlCalls

create a call

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

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 application_sid or call_hook 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
codecslist of stringsOptional

Codec names, in preference order, to offer on the outbound INVITE. Names are case-insensitive. When omitted the media server offers its default codecs. If any name is not supported the whole list is ignored, an error is logged and an alert is written, and default negotiation is used.

tagobjectOptional

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

headersobjectOptional
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)

amdobjectOptional
dual_streamsbooleanOptional

If set to true, jambonz generates an outbound INVITE whose SDP offer contains two audio media streams (two m=audio lines) instead of one. This is useful when the far end (for example a carrier or recording system) requires the inbound and outbound audio to be delivered on separate RTP streams. Defaults to false. Supported only when creating a call via the REST API (i.e. not available from the dial verb).

Response

call successfully created
sidstringformat: "uuid"

Errors

400
Bad Request Error