Skip to main content
POST
cURL

Example Request

Both from and to numbers must include the + prefix and country code. The from number must be a Twilio number associated with your account.
Use options.messagesHistory to provide conversation context, or options.agentOverrides to customize agent behavior for the call.
Calls incur usage charges. Monitor your usage to avoid unexpected costs.

Body

application/json
from
string

This is the number that agent needs to call, must start with a "+" and must not include any spaces or special characters, they will automatically be removed.

Pattern: ^\+
to
string

This is the number that agent needs to call, must start with a "+"

Pattern: ^\+
agentId
string

This is the agent id to use for the call.

campaignId
string

This is the campaign id to use for the call that is part of campaign

options
object

This is the overrides to use for the agent.

leadInfo
object
convoId
string

Custom conversation ID to use as Convocore session ID

Response

Successful response

message
string
required

This is the message of the call.

websocketUrl
string

This is the websocket url.

callData
any

This is the call data from twilio.

options
object

This is the overrides to use for the agent.

listenUrl
string

This is the listen url.