Skip to main content
GET
List call ids

Autorizaciones

Authorization
string
header
requerido

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

Parámetros de consulta

agent_id
string<uuid> | null
status
enum<string> | null

Call lifecycle state. Only four states: a call is dialing, waiting in the queue, in progress, or completed. Every terminal outcome — answered, transferred, refused, no-answer, errored — is COMPLETED; the specific outcome lives in Call.end_reason (see EndReason).

Opciones disponibles:
dialing,
in_queue,
in_progress,
completed
type
enum<string> | null
Opciones disponibles:
inbound,
outbound
start_created_date
string<date-time> | null
end_created_date
string<date-time> | null
contact_id
string<uuid> | null
phone_id
string<uuid> | null
contact_phone
string | null
Minimum string length: 3
search
string | null
Minimum string length: 2
end_reason
enum<string> | null
Opciones disponibles:
user_hang_up,
agent_hang_up,
user_did_not_answer,
answering_machine_detected,
voicemail_left,
mailbox_unavailable,
ivr_unreachable,
ivr_no_answer,
path_completed,
transfer,
error,
pre_call_flow_failed,
concurrency_limit,
no_remaining_seconds,
user_left_queue,
queue_timeout,
unknown

Respuesta

Successful Response

call_ids
string<uuid>[]
requerido

Ids of the calls matching the filters.

total
integer
requerido

Number of ids returned.