Skip to main content
POST
Start an outbound call

Authorizations

Authorization
string
header
required

An organization API key starting with dh_, sent as Authorization: Bearer dh_your_api_key.

Body

application/json
from_number
string
required

A phone number your organization owns. The caregiver attached to it runs the call.

Example:

"+15551110000"

to_number
string
required

The phone number to call.

Example:

"+15552220000"

variables
object[]

Values the caregiver can use during the call.

Response

The call was initiated.

err
boolean
required
Example:

false

msg
string
required
Example:

"Call initiated successfully"

results
object
required