List calls | Hams AI Docs

{
  "data": [
    {
      "id": "string",
      "started_at": "2024-01-15T09:30:00Z",
      "direction": "string",
      "outcome": "answered",
      "outcome_detail": "string",
      "from_number": "string",
      "from_type": "string",
      "to_number": "string",
      "to_type": "string",
      "answered_at": "2024-01-15T09:30:00Z",
      "ended_at": "2024-01-15T09:30:00Z",
      "total_seconds": 1,
      "talk_seconds": 1,
      "ring_seconds": 1,
      "queue_wait_seconds": 1,
      "queue_handled": true,
      "queues_touched": 1,
      "agent_user_id": "string",
      "agent_extension_snapshot": "string",
      "agent_name_snapshot": "string",
      "data_quality": "string",
      "account_id": "string",
      "domain_id": "string",
      "did_id": "string",
      "trunk_id": "string",
      "recording_id": "string",
      "recording_status": "string",
      "transcript_status": "pending",
      "transcript_error": "too_long",
      "analysis_status": "pending",
      "analysis_outcome": "resolved",
      "analysis_sentiment_end": "very_negative",
      "analysis_agent_score": 1,
      "analysis_labels": [
        "string"
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "string",
  "total_count": 1
}

List the call detail records of the whole account. The list is cursor-paginated. The newest call is first. Filters: direction, outcome, agent extension, call start range, number, and duration. Without from, the list has only the calls of the last 7 days. A range of more than 92 days returns 422. A from value after to also returns 422.

Authentication

AuthorizationBearer

An API key. Send it as Authorization: Bearer ccc_live_…

Query parameters

cursorstring or nullOptional

The cursor from the previous page. Do not change it

limitintegerOptional1-100Defaults to 25

include_totalbooleanOptionalDefaults to false

Add an exact count to the response. This causes an extra query

directionenum or nullOptional

The direction of the call

Allowed values:

outcomeenum or nullOptional

The outcome of the call

agentstring or nullOptional

The extension number of the agent that handled the call

fromdatetime or nullOptional

Only calls that start at or after this time. The value must include a timezone. Without it, the API returns 422

todatetime or nullOptional

Only calls that start before this time. The value must include a timezone. Without it, the API returns 422. The default is now

numberstring or nullOptional>=3 characters

A substring of the caller number or the callee number

min_durationinteger or nullOptional>=0

The minimum value of total_seconds

max_durationinteger or nullOptional>=0

The maximum value of total_seconds

Response

Successful Response

datalist of objects

has_moreboolean

next_cursorstring or nullOptional

total_countinteger or nullOptional

Errors

401

Unauthorized Error

422

Unprocessable Entity Error

429

Too Many Requests Error