Skip to navigation

Make a call

Initiate an outbound call to the specified phone number.

The call will use the specified voice agent and any metadata provided will be available to the agent during the conversation.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
agent_idstringRequired>=1 character
Voice agent UUID
source_numberstringRequired>=1 character

Source phone number to call from (+91…)

phone_numberstringRequired>=1 character

Phone to call (+91…)

metadataobject or nullOptional
Custom data for agent

Response

Successful Response
dataobject
Call data inside response envelope.
request_idstring
timestampdatetime
successbooleanOptionalDefaults to true

Errors

422
Unprocessable Entity Error