Skip to navigation

Get call history

Get paginated call history with comprehensive filters.

Filters:

  • status: completed, failed, no_answer, voicemail
  • phone_number: partial match
  • agent_id: specific agent
  • from_date/to_date: date range
  • direction: inbound/outbound
  • sentiment: positive/neutral/negative
  • min_duration/max_duration: duration range in seconds
  • call_end_reason: user_hangup, agent_hangup, timeout
  • handover: true/false

Authentication

AuthorizationBearer

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

Query parameters

pageintegerOptional>=1Defaults to 1
Page number
page_sizeintegerOptional1-100Defaults to 20
Items per page
statusstring or nullOptional

completed, failed, no_answer, voicemail

phone_numberstring or nullOptional

Filter by phone number (partial match)

agent_idstring or nullOptional
Filter by agent ID
from_datestring or nullOptional

Start: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS

to_datestring or nullOptional

End: YYYY-MM-DD (the whole day) or YYYY-MM-DDTHH:MM:SS

directionstring or nullOptional
inbound or outbound
sentimentstring or nullOptional
positive, neutral, negative
agent_typestring or nullOptional
Filter by agent type
min_durationinteger or nullOptional>=0
Min duration in seconds
max_durationinteger or nullOptional>=0
Max duration in seconds
call_end_reasonstring or nullOptional

user_hangup, agent_hangup, timeout

handoverboolean or nullOptional
Filter by handover status
campaign_idstring or nullOptional

Only one campaign’s calls (GET /campaigns), callbacks to it included

Response

Successful Response
datalist of objects
totalinteger
pageinteger
page_sizeinteger
has_moreboolean
request_idstring
timestampdatetime
successbooleanOptionalDefaults to true

Errors

422
Unprocessable Entity Error