Calls
End Call
Calls
End Call
POST
/
v1
/
calls
/
end
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
id
string
requiredResponse
200 - application/json
id
string
requireduser_id
string
requiredstatus
enum<string>
An enumeration.
Available options:
not_started, in_progress, error, ended error_message
string
recording_available
boolean
default: falsetranscript
string
human_detection_result
enum<string>
Available options:
human, no_human do_not_call_result
boolean
telephony_id
string
stage
enum<string>
Available options:
created, picked_up, transfer_started, transfer_successful stage_outcome
enum<string>
Available options:
human_unanswered, call_did_not_connect, human_disconnected, bot_disconnected, transfer_unanswered, transfer_disconnected telephony_metadata
object
to_number
string
requiredfrom_number
string
requiredagent
object
requiredtelephony_provider
enum<string>
requiredAvailable options:
vonage, twilio agent_phone_number
string
requiredstart_time
string
end_time
string
hipaa_compliant
boolean
default: falseon_no_human_answer
enum<string>
Available options:
continue, hangup context
object
run_do_not_call_detection
boolean
telephony_account_connection
object
telephony_params
object