Calls
Create Call
POST
/
v1
/
calls
/
create
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
from_number
string
requiredto_number
string
requiredagent
required
on_no_human_answer
enum<string>
default: continueAvailable options:
continue
, hangup
run_do_not_call_detection
boolean | null
hipaa_compliant
boolean
default: falsecontext
object | null
telephony_params
object | null
Response
200 - application/json
id
string
requireduser_id
string
requiredto_number
string
requiredfrom_number
string
requiredagent
object
requiredtelephony_provider
enum<string>
requiredAvailable options:
vonage
, twilio
agent_phone_number
string
requiredstatus
enum<string>
default: not_startedAvailable options:
not_started
, in_progress
, error
, ended
error_message
string | null
recording_available
boolean
default: falsetranscript
string | null
human_detection_result
enum<string> | null
Available options:
human
, no_human
do_not_call_result
boolean | null
telephony_id
string | null
stage
enum<string> | null
Available options:
created
, picked_up
, transfer_started
, transfer_successful
stage_outcome
enum<string> | null
Available options:
human_unanswered
, call_did_not_connect
, human_disconnected
, bot_disconnected
, transfer_unanswered
, transfer_disconnected
telephony_metadata
object | null
start_time
string | null
end_time
string | null
hipaa_compliant
boolean
default: falseon_no_human_answer
enum<string> | null
Available options:
continue
, hangup
context
object | null
run_do_not_call_detection
boolean | null
telephony_account_connection
object | null
telephony_params
object | null