Skip to main content
GET
Get Click-to-Call Live Status
Check the real-time status of one or more click-to-call (C2C) calls that were started with the Click-to-Dial API. Use it to poll a call you just triggered, or to pull a rolled-up view of every click-to-call made by your workspace on a given day.

API Endpoint

{call_id} is optional. Two distinct modes are supported depending on whether it’s supplied: Content-Type: application/json Authentication: Required (Token header: token or api_access_token) The token determines which company/workspace the request is scoped to — you cannot query calls belonging to another workspace.

Single Call: GET /c2c-live-status/{call_id}

Returns the live status of exactly one call.

Path Parameter

Success Response

Status Code: 200 OK

Response Fields

data.status Fields

The exact set of status/label values that can appear in live_status.timeline and call_status may grow over time as new call states are added — don’t hardcode an exhaustive list; use keep_polling to decide when to stop polling.

Failure Example

A lookup failure for an unknown call still comes back as HTTP 200 with success: false inside data — it is not a top-level API error. Always branch on data.success, not on the HTTP status code, when reading the result.

Bulk / Date Range: GET /c2c-live-status

Omit call_id to get the live status of every click-to-call made by your workspace within a date range. Defaults to today if no range is given.

Query Parameters

fromDate / toDate (camelCase) are also accepted as aliases.

Success Response

Status Code: 200 OK

Response Fields

Only calls that were triggered via the Click-to-Dial trigger API for your workspace are included — this does not cover calls made through other channels (e.g. AI voice agent calling).

Error Responses

All errors are returned in a common envelope. Always check the error field of the response body.

401 Unauthorized

400 Bad Request

Per-call lookup failures (unknown call id, upstream timeout, etc.) do not raise an HTTP error — they surface as success: false within the relevant entry, as shown above.

Example Requests

Poll a single call

Get today’s activity

Get activity over a date range

Typical Flow

  1. Trigger a call with the Click-to-Dial API and capture the returned call_id
  2. Poll GET /c2c-live-status/{call_id} until the call reaches a terminal state, or
  3. Periodically call GET /c2c-live-status (no call_id) to get a snapshot of all of today’s click-to-call activity, e.g. for a dashboard

Important Notes

Status Payload

  • data.status.live_status.timeline gives you the full history of the call across both legs — leg: 1 is the customer, leg: 2 is the agent
  • Use data.status.keep_polling to decide when to stop polling, rather than matching on specific call_status/timeline label values, since new statuses may be added over time
  • Always check data.success before reading data.status

Scope

  • The token determines which workspace’s calls are visible; you cannot query calls belonging to another workspace
  • The bulk endpoint only returns calls triggered via the Click-to-Dial trigger API — it does not include calls made through other channels such as AI voice agent calling

Date Ranges

  • If fromdate and todate are both omitted, the range defaults to today
  • If only fromdate is supplied, todate defaults to the same day

Headers

token
string
required

API token for authentication

Path Parameters

call_id
string
required

The call identifier returned by the Click-to-Dial trigger API

Response

Live status retrieved successfully

error
boolean
code
integer
message
string
timestamp
integer
data
object