Calls
End Call
POST
/
v1
/
calls
/
end
curl --request POST \
--url https://api.vocode.dev/v1/calls/end \
--header 'Authorization: <authorization>'
{
"agent": {
"actions": [],
"context_endpoint": "<string>",
"conversation_speed": 123,
"endpointing_sensitivity": "auto",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"initial_message": "<string>",
"initial_message_delay": 123,
"interrupt_sensitivity": "low",
"ivr_navigation_mode": "default",
"language": "en",
"noise_suppression": true,
"openai_account_connection": {
"credentials": {
"openai_api_key": "<string>"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "account_connection_openai",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"openai_model_name_override": "<string>",
"prompt": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vector_database": {
"api_environment": "<string>",
"api_key": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"index": "<string>",
"type": "vector_database_pinecone",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"voice": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "voice_azure",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"voice_name": "<string>"
},
"webhook": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subscriptions": [],
"url": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"agent_phone_number": "<string>",
"context": {},
"do_not_call_result": true,
"end_time": "2023-11-07T05:31:56Z",
"error_message": "<string>",
"from_number": "<string>",
"hipaa_compliant": true,
"human_detection_result": "human",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"on_no_human_answer": "continue",
"recording_available": true,
"run_do_not_call_detection": true,
"start_time": "2023-11-07T05:31:56Z",
"status": "not_started",
"telephony_account_connection": {
"credentials": {
"twilio_account_sid": "<string>",
"twilio_auth_token": "<string>"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "account_connection_twilio",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"telephony_id": "<string>",
"telephony_provider": "vonage",
"to_number": "<string>",
"transcript": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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
agent
object
requiredagent_phone_number
string
requiredcontext
object
do_not_call_result
boolean
end_time
string
error_message
string
from_number
string
requiredhipaa_compliant
boolean
default: falsehuman_detection_result
enum<string>
Available options:
human
, no_human
id
string
requiredon_no_human_answer
enum<string>
Available options:
continue
, hangup
recording_available
boolean
default: falserun_do_not_call_detection
boolean
start_time
string
status
enum<string>
An enumeration.
Available options:
not_started
, in_progress
, error
, ended
telephony_account_connection
object
telephony_id
string
telephony_provider
enum<string>
requiredAvailable options:
vonage
, twilio
to_number
string
requiredtranscript
string
user_id
string
requiredcurl --request POST \
--url https://api.vocode.dev/v1/calls/end \
--header 'Authorization: <authorization>'
{
"agent": {
"actions": [],
"context_endpoint": "<string>",
"conversation_speed": 123,
"endpointing_sensitivity": "auto",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"initial_message": "<string>",
"initial_message_delay": 123,
"interrupt_sensitivity": "low",
"ivr_navigation_mode": "default",
"language": "en",
"noise_suppression": true,
"openai_account_connection": {
"credentials": {
"openai_api_key": "<string>"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "account_connection_openai",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"openai_model_name_override": "<string>",
"prompt": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vector_database": {
"api_environment": "<string>",
"api_key": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"index": "<string>",
"type": "vector_database_pinecone",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"voice": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "voice_azure",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"voice_name": "<string>"
},
"webhook": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subscriptions": [],
"url": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"agent_phone_number": "<string>",
"context": {},
"do_not_call_result": true,
"end_time": "2023-11-07T05:31:56Z",
"error_message": "<string>",
"from_number": "<string>",
"hipaa_compliant": true,
"human_detection_result": "human",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"on_no_human_answer": "continue",
"recording_available": true,
"run_do_not_call_detection": true,
"start_time": "2023-11-07T05:31:56Z",
"status": "not_started",
"telephony_account_connection": {
"credentials": {
"twilio_account_sid": "<string>",
"twilio_auth_token": "<string>"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "account_connection_twilio",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"telephony_id": "<string>",
"telephony_provider": "vonage",
"to_number": "<string>",
"transcript": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}