Skip to main content
POST
Make an outbound call

Authorizations

Authorization
string
header
default:<auth-token>
required

Your API token, sent raw (no Bearer prefix).

Body

application/json
sipCallTo
string
required

The number to call, in E.164 with the +.

Example:

"+14155550199"

sipCallFrom
string
required

Your number to call from, in E.164 with the +.

Example:

"+14155550100"

routingRuleId
string

An outbound routing rule. Leave it out to use the first outbound rule on sipCallFrom.

Example:

"rr_2554md"

participant
object

How the callee appears in the room.

metadata
object

Your own data for this call. Stored on the call and passed to the agent.

Response

The call was started, not answered yet. status starts as initiated.

message
string
Example:

"Call initiated successfully"

data
object