Calls
Get Call
Calls
Get Call
GET
/
v1
/
calls
curl --request GET \
--url https://api.vocode.dev/v1/calls \
--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": 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": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"prompt": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": "<string>",
"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",
"label": "<string>",
"required_context_keys": [
"<string>"
]
}
},
"language": "en",
"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": 123,
"rate": 123
},
"initial_message": "<string>",
"webhook": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subscriptions": [
"event_message"
],
"url": "<string>",
"method": "GET"
},
"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": true,
"endpointing_sensitivity": "auto",
"ivr_navigation_mode": "default",
"conversation_speed": 123,
"initial_message_delay": 123,
"openai_model_name_override": "<string>",
"ask_if_human_present_on_idle": true,
"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": true,
"llm_temperature": 123
},
"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": {
"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": true
},
"telephony_params": {}
}
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
telephony_metadata.type
enum<string>
default: telephony_metadata_vonageAvailable options:
telephony_metadata_vonage
to_number
string
requiredfrom_number
string
requiredagent
object
requiredagent.id
string
requiredagent.user_id
string
requiredagent.name
string
agent.prompt
object
requiredagent.prompt.id
string
requiredagent.prompt.user_id
string
requiredagent.prompt.content
string
default: agent.prompt.collect_fields
object[]
agent.prompt.collect_fields.field_type
enum<string>
requiredAvailable options:
field_type_email
agent.prompt.collect_fields.label
string
requiredagent.prompt.collect_fields.name
string
requiredagent.prompt.collect_fields.description
string
agent.prompt.context_endpoint
string
agent.prompt.prompt_template
object
agent.prompt.prompt_template.id
string
requiredagent.prompt.prompt_template.user_id
string
requiredagent.prompt.prompt_template.label
string
default: agent.prompt.prompt_template.required_context_keys
string[]
requiredagent.language
enum<string>
An enumeration.
Available options:
en
, es
, de
, hi
, pt
, fr
, nl
, id
, it
, ja
, ko
agent.actions
object[]
requiredagent.actions.id
string
requiredagent.actions.user_id
string
requiredagent.actions.type
enum<string>
requiredAvailable options:
action_transfer_call
agent.actions.config
object
requiredagent.actions.config.phone_number
string
requiredagent.actions.action_trigger
object
agent.actions.action_trigger.type
enum<string>
requiredAvailable options:
action_trigger_function_call
agent.actions.action_trigger.config
object
agent.voice
object
requiredagent.voice.id
string
requiredagent.voice.user_id
string
requiredagent.voice.type
enum<string>
requiredAvailable options:
voice_azure
agent.voice.voice_name
string
requiredagent.voice.pitch
integer
default: 0agent.voice.rate
integer
default: 15agent.initial_message
string
agent.webhook
object
agent.webhook.id
string
requiredagent.webhook.user_id
string
requiredagent.webhook.subscriptions
enum<string>[]
requiredAvailable options:
event_message
, event_action
, event_phone_call_connected
, event_phone_call_ended
, event_phone_call_did_not_connect
, event_transcript
, event_recording
, event_human_detection
agent.webhook.url
string
requiredagent.webhook.method
enum<string>
An enumeration.
Available options:
GET
, POST
agent.vector_database
object
agent.vector_database.id
string
requiredagent.vector_database.user_id
string
requiredagent.vector_database.type
enum<string>
requiredAvailable options:
vector_database_pinecone
agent.vector_database.index
string
requiredagent.vector_database.api_key
string
requiredagent.vector_database.api_environment
string
requiredagent.interrupt_sensitivity
enum<string>
An enumeration.
Available options:
low
, high
agent.context_endpoint
string
agent.noise_suppression
boolean
default: falseagent.endpointing_sensitivity
enum<string>
default: autoAvailable options:
auto
, relaxed
, sensitive
agent.ivr_navigation_mode
enum<string>
default: offAvailable options:
default
, off
agent.conversation_speed
number
default: 1agent.initial_message_delay
number
default: 0agent.openai_model_name_override
string
agent.ask_if_human_present_on_idle
boolean
default: falseagent.openai_account_connection
object
agent.openai_account_connection.id
string
requiredagent.openai_account_connection.user_id
string
requiredagent.openai_account_connection.credentials
object
requiredagent.openai_account_connection.credentials.openai_api_key
string
requiredagent.openai_account_connection.type
enum<string>
requiredAvailable options:
account_connection_openai
agent.run_do_not_call_detection
boolean
default: falseagent.llm_temperature
number
default: 0telephony_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_account_connection.id
string
requiredtelephony_account_connection.user_id
string
requiredtelephony_account_connection.credentials
object
requiredtelephony_account_connection.credentials.twilio_account_sid
string
requiredtelephony_account_connection.credentials.twilio_auth_token
string
requiredtelephony_account_connection.type
enum<string>
requiredAvailable options:
account_connection_twilio
telephony_account_connection.steering_pool
string[]
telephony_account_connection.account_supports_any_caller_id
boolean
default: falsetelephony_params
object
curl --request GET \
--url https://api.vocode.dev/v1/calls \
--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": 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": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"prompt": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": "<string>",
"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",
"label": "<string>",
"required_context_keys": [
"<string>"
]
}
},
"language": "en",
"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": 123,
"rate": 123
},
"initial_message": "<string>",
"webhook": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subscriptions": [
"event_message"
],
"url": "<string>",
"method": "GET"
},
"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": true,
"endpointing_sensitivity": "auto",
"ivr_navigation_mode": "default",
"conversation_speed": 123,
"initial_message_delay": 123,
"openai_model_name_override": "<string>",
"ask_if_human_present_on_idle": true,
"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": true,
"llm_temperature": 123
},
"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": {
"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": true
},
"telephony_params": {}
}