Calls
List Calls
Calls
List Calls
GET
/
v1
/
calls
/
list
curl --request GET \
--url https://api.vocode.dev/v1/calls/list \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "not_started",
"error_message": "<string>",
"recording_available": true,
"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"
},
"to_number": "<string>",
"from_number": "<string>",
"agent": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"telephony_provider": "vonage",
"agent_phone_number": "<string>",
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"hipaa_compliant": true,
"on_no_human_answer": "continue",
"context": {},
"run_do_not_call_detection": true,
"telephony_account_connection": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"telephony_params": {}
}
],
"page": 123,
"size": 123,
"has_more": true,
"total": 123,
"total_is_estimated": true
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
page
integer
default: 1size
integer
default: 10sort_column
string
sort_desc
boolean
default: falseResponse
200 - application/json
items
object[]
requireditems.id
string
requireditems.user_id
string
requireditems.status
enum<string>
An enumeration.
Available options:
not_started
, in_progress
, error
, ended
items.error_message
string
items.recording_available
boolean
default: falseitems.transcript
string
items.human_detection_result
enum<string>
Available options:
human
, no_human
items.do_not_call_result
boolean
items.telephony_id
string
items.stage
enum<string>
Available options:
created
, picked_up
, transfer_started
, transfer_successful
items.stage_outcome
enum<string>
Available options:
human_unanswered
, call_did_not_connect
, human_disconnected
, bot_disconnected
, transfer_unanswered
, transfer_disconnected
items.telephony_metadata
object
items.telephony_metadata.type
enum<string>
default: telephony_metadata_vonageAvailable options:
telephony_metadata_vonage
items.to_number
string
requireditems.from_number
string
requireditems.agent
string
requireditems.telephony_provider
enum<string>
requiredAvailable options:
vonage
, twilio
items.agent_phone_number
string
requireditems.start_time
string
items.end_time
string
items.hipaa_compliant
boolean
default: falseitems.on_no_human_answer
enum<string>
Available options:
continue
, hangup
items.context
object
items.run_do_not_call_detection
boolean
items.telephony_account_connection
items.telephony_params
object
page
integer
requiredsize
integer
requiredhas_more
boolean
requiredtotal
integer
requiredtotal_is_estimated
boolean
requiredcurl --request GET \
--url https://api.vocode.dev/v1/calls/list \
--header 'Authorization: Bearer <token>'
{
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "not_started",
"error_message": "<string>",
"recording_available": true,
"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"
},
"to_number": "<string>",
"from_number": "<string>",
"agent": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"telephony_provider": "vonage",
"agent_phone_number": "<string>",
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"hipaa_compliant": true,
"on_no_human_answer": "continue",
"context": {},
"run_do_not_call_detection": true,
"telephony_account_connection": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"telephony_params": {}
}
],
"page": 123,
"size": 123,
"has_more": true,
"total": 123,
"total_is_estimated": true
}