Click2Call

Read a Click2Call call

Returns the current state of one call. This is the polling endpoint: call it until state is completed or failed.

States

State	Meaning
accepted	The call was placed; no leg has moved yet
agent_ringing	Your SIP account is ringing — best-effort, may be skipped
agent_answered	Your SIP account answered
customer_ringing	The destination is being dialled
bridged	Both legs are up and talking
completed	The call ended normally
failed	The call did not come together

agent_ringing is derived from a ringing indication on the agent leg, which some user agents never send. A call may therefore go straight from accepted to agent_answered; clients must not require agent_ringing.

reason

reason answers why the call ended, on its own axis from state. It is null while the call is live and on a normal end. Otherwise it is one of no_answer, busy, unreachable, canceled, timed_out or platform_error. A call your own DELETE ended reports canceled — including when it had already been answered, in which case state is completed. A DELETE that arrives after the call has already ended leaves the original reason in place.

Retention

A call is readable for 12 hours from the moment it was placed — not from the moment it ended. After that the record is gone and this endpoint answers 404. Call history is a separate product surface.

404

404 call_not_found means the call is unknown to you: it never existed, the ID is malformed, it belongs to another account, or it has fallen out of the 12-hour window. The cases are deliberately indistinguishable.

data.recording_url feeds recordings_show. See also: click2call_destroy.

get/api/v1/click2call/{id}

Request

Base URL: https://app.didlogic.com
URL: https://app.didlogic.com/api/v1/click2call/{id}
Auth: HTTP bearer

Path parameters

idstring required

Call ID (data.id) from click2call_create, a 26-character ULID

Response

The current state of the call.

Example response

{
  "data": {
    "id": "01K0SPIKE0000000000000002A",
    "state": "completed",
    "reason": "canceled",
    "a_type": "sip_account",
    "a_endpoint": "10001",
    "b_number": "447700900000",
    "created_at": "2026-07-31T10:00:00.000Z",
    "agent_ringing_at": "2026-07-31T10:00:03.000Z",
    "agent_answered_at": "2026-07-31T10:00:07.000Z",
    "customer_ringing_at": "2026-07-31T10:00:08.000Z",
    "bridged_at": "2026-07-31T10:00:15.000Z",
    "ended_at": "2026-07-31T10:01:20.000Z",
    "duration": 79,
    "cost": "0.1350",
    "finalized_at": "2026-07-31T10:01:22.000Z",
    "a_cli": "447700900000"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.