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",
  "status": "not_started",
  "error_message": "<string>",
  "recording_available": false,
  "transcript": "<string>",
  "to_number": "<string>",
  "from_number": "<string>",
  "agent": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "prompt": "<string>",
    "actions": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "action_end_conversation",
        "config": {
          "phone_number": "<string>"
        }
      }
    ],
    "voice": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "voice_base",
      "voice_name": "<string>",
      "pitch": 0,
      "rate": 15
    },
    "initial_message": "<string>",
    "webhook": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subscriptions": [
        "event_message"
      ],
      "url": "<string>",
      "method": "GET"
    }
  }
}

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
object
required
​
status
enum<string>
default:not_started

An enumeration.

Available options:
not_started,
in_progress,
error,
ended
​
error_message
string
​
recording_available
boolean
default:false
​
transcript
string