Calls

Start an outbound call

View as Markdown
Initiates an outbound conversation with a specified agent and phone number.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Request

This endpoint expects an object.
agentIdstringRequired
The ID of the agent initiating the conversation
phoneNumberstringRequired
The phone number to call
variablesobjectOptional
The variables to pass to the conversation
fromProductIdstringOptional

The ID of the product to use for the call (get this from the /product/phone-numbers endpoint)

Response

Successfully started the outbound conversation
statusboolean
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error