INinkbox
Phone Calls

List Agent Calls

Changed on
get/api/v1/phone/calls

Request

  • Base URL
    https://api.inkbox.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.inkbox.ai/api/v1/phone/calls
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Query parameters

agent_identity_idstring uuid nullable

Agent identity to list calls for. Agent-scoped keys resolve their own; required for admin/JWT.

limitinteger
offsetinteger
is_blockedboolean nullable
start_datetimestring nullable

Filter created_at >= this date/datetime. Bare date => whole day in tz.

end_datetimestring nullable

Filter created_at <= this date/datetime. Bare date => whole day inclusive.

tzstring nullable

IANA zone (e.g. America/New_York) for zone-less values; default UTC.

Response

Successful Response

idstring uuid required
origin'dedicated_number' | 'shared_imessage_number' | 'dedicated_imessage_number'
local_phone_numberstring nullable
remote_phone_numberstring required
direction'outbound' | 'inbound' required
status'initiated' | 'ringing' | 'answered' | 'completed' | 'failed' | 'canceled' required
client_websocket_urlstring nullable required
mode'client_websocket' | 'hosted_agent'
hosted_agent_authority_mode'contact_scoped' | 'yolo'
voicemail_detection'enabled' | 'disabled'
on_voicemail'hang_up' | 'leave_message' | 'ignore'
reasonstring nullable
use_inkbox_ttsboolean nullable required
use_inkbox_sttboolean nullable required
hangup_reason'local' | 'remote' | 'max_duration' | 'voicemail' | 'rejected' | 'failed' | 'no_answer' | 'missed' | 'busy' | 'dropped'
ended_by'local' | 'remote' | 'unknown'
provider_hangup_causestring nullable
started_atstring date-time nullable required
ended_atstring date-time nullable required
is_blockedboolean
created_atstring date-time required
updated_atstring date-time required

Changes