Skip to main content
POST
/
v1
/
calls
/
end
End Call
curl --request POST \
  --url https://api.vocode.dev/v1/calls/end \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "to_number": "<string>",
  "from_number": "<string>",
  "agent": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "prompt": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "content": "",
      "collect_fields": [
        {
          "field_type": "field_type_email",
          "label": "<string>",
          "name": "<string>",
          "description": "<string>"
        }
      ],
      "context_endpoint": "<string>",
      "prompt_template": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "required_context_keys": [
          "<string>"
        ],
        "label": ""
      }
    },
    "actions": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "action_transfer_call",
        "config": {
          "phone_number": "<string>"
        },
        "action_trigger": {
          "type": "action_trigger_function_call",
          "config": {}
        }
      }
    ],
    "voice": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "voice_azure",
      "voice_name": "<string>",
      "pitch": 0,
      "rate": 15
    },
    "name": "<string>",
    "language": "en",
    "initial_message": "<string>",
    "webhook": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subscriptions": [
        "event_message"
      ],
      "url": "<string>",
      "method": "POST"
    },
    "vector_database": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "vector_database_pinecone",
      "index": "<string>",
      "api_key": "<string>",
      "api_environment": "<string>"
    },
    "interrupt_sensitivity": "low",
    "context_endpoint": "<string>",
    "noise_suppression": false,
    "endpointing_sensitivity": "auto",
    "ivr_navigation_mode": "off",
    "conversation_speed": 1,
    "initial_message_delay": 0,
    "openai_model_name_override": "<string>",
    "ask_if_human_present_on_idle": false,
    "openai_account_connection": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "credentials": {
        "openai_api_key": "<string>"
      },
      "type": "account_connection_openai"
    },
    "run_do_not_call_detection": false,
    "llm_fallback": {
      "provider": "openai",
      "model_name": "<string>"
    },
    "deepgram_keywords": {},
    "idle_time_seconds": 123,
    "llm_temperature": 0
  },
  "telephony_provider": "vonage",
  "agent_phone_number": "<string>",
  "status": "not_started",
  "error_message": "<string>",
  "recording_available": false,
  "transcript": "<string>",
  "human_detection_result": "human",
  "do_not_call_result": true,
  "telephony_id": "<string>",
  "stage": "created",
  "stage_outcome": "human_unanswered",
  "telephony_metadata": {
    "type": "telephony_metadata_vonage"
  },
  "start_time": "<string>",
  "end_time": "<string>",
  "hipaa_compliant": false,
  "on_no_human_answer": "continue",
  "context": {},
  "run_do_not_call_detection": true,
  "telephony_account_connection": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "credentials": {
      "twilio_account_sid": "<string>",
      "twilio_auth_token": "<string>"
    },
    "type": "account_connection_twilio",
    "steering_pool": [
      "<string>"
    ],
    "account_supports_any_caller_id": false
  },
  "telephony_params": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.vocode.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
id
string<uuid>
required

Response

Successful Response

​
id
string<uuid>
required
​
user_id
string<uuid>
required
​
to_number
string
required
​
from_number
string
required
​
agent
Agent · object
required
​
telephony_provider
enum<string>
required
Available options:
vonage,
twilio
​
agent_phone_number
string
required
​
status
enum<string>
default:not_started
Available options:
not_started,
in_progress,
error,
ended
​
error_message
string | null
​
recording_available
boolean
default:false
​
transcript
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
VonageTelephonyMetadata · object
​
start_time
string | null
​
end_time
string | null
​
hipaa_compliant
boolean
default:false
​
on_no_human_answer
enum<string> | null
Available options:
continue,
hangup
​
context
Context · object
​
run_do_not_call_detection
boolean | null
​
telephony_account_connection
TwilioAccountConnection · object
​
telephony_params
Telephony Params · object