Calls
List calls
GET
/
v1
/
calls
/
list
{
"items": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"user_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "in_progress",
"error_message": "Call failed to connect",
"recording_available": true,
"transcript": "Hello, this is a transcript",
"human_detection_result": "human",
"do_not_call_result": false,
"telephony_id": "call_123",
"stage": "created",
"stage_outcome": "human_unanswered",
"telephony_metadata": {},
"start_time": "2023-01-01T00:00:00Z",
"end_time": "2023-01-01T00:01:00Z",
"to_number": "+1234567890",
"from_number": "+0987654321",
"telephony_provider": "twilio",
"agent_phone_number": "+1234567890",
"hipaa_compliant": false,
"on_no_human_answer": "continue",
"context": {},
"run_do_not_call_detection": true,
"telephony_account_connection": {},
"telephony_params": {},
"is_outgoing": true,
"errors": [
"Error 1",
"Error 2"
],
"agent": "agent_123"
}
],
"page": 123,
"size": 123,
"has_more": true,
"total": 123,
"total_is_estimated": true
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Response
200
application/json
Example:
"550e8400-e29b-41d4-a716-446655440000"
Example:
"550e8400-e29b-41d4-a716-446655440000"
Example:
"+1234567890"
Example:
"+0987654321"
Example:
"twilio"
Example:
"+1234567890"
Example:
"agent_123"
Available options:
not_started
, in_progress
, error
, ended
Example:
"in_progress"
Example:
"Call failed to connect"
Example:
true
Example:
"Hello, this is a transcript"
Available options:
human
, no_human
Example:
"human"
Example:
false
Example:
"call_123"
Available options:
created
, picked_up
, transfer_started
, transfer_successful
Example:
"created"
Available options:
human_unanswered
, call_did_not_connect
, human_disconnected
, bot_disconnected
, transfer_unanswered
, transfer_disconnected
Example:
"human_unanswered"
Example:
"2023-01-01T00:00:00Z"
Example:
"2023-01-01T00:01:00Z"
Example:
false
Available options:
continue
, hangup
Example:
"continue"
Example:
true
Example:
true
Example:
["Error 1", "Error 2"]
{
"items": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"user_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "in_progress",
"error_message": "Call failed to connect",
"recording_available": true,
"transcript": "Hello, this is a transcript",
"human_detection_result": "human",
"do_not_call_result": false,
"telephony_id": "call_123",
"stage": "created",
"stage_outcome": "human_unanswered",
"telephony_metadata": {},
"start_time": "2023-01-01T00:00:00Z",
"end_time": "2023-01-01T00:01:00Z",
"to_number": "+1234567890",
"from_number": "+0987654321",
"telephony_provider": "twilio",
"agent_phone_number": "+1234567890",
"hipaa_compliant": false,
"on_no_human_answer": "continue",
"context": {},
"run_do_not_call_detection": true,
"telephony_account_connection": {},
"telephony_params": {},
"is_outgoing": true,
"errors": [
"Error 1",
"Error 2"
],
"agent": "agent_123"
}
],
"page": 123,
"size": 123,
"has_more": true,
"total": 123,
"total_is_estimated": true
}