Skip to main content
POST
Create phone call

Authorizations

Authorization
string
header
required

API key from Voxworks, sent as Authorization: Bearer YOUR_API_KEY.

Body

application/json
from_number
string
required

Phone number to call from. Must belong to your team.

script_id
string
required
contact
object
required
objects
object

Object data keyed by object type name.

scheduled_time
string<date-time>

ISO 8601 timestamp. Defaults to now.

Response

Call scheduled.

success
boolean
required
Example:

true

call_id
string
required
contact_id
string
required
status
string
required
Example:

"scheduled"