Call Status

GET 
/calls/:call_control_id/status

Returns the status of a given call.

Request

Path Parameters

call_control_id stringrequired

Unique identifier and token for controlling the call

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

record_type stringrequired

The type of record being returned. This will always be 'call'

call_control_id stringrequired

Unique identifier and token for controlling the call

call_leg_id stringrequired

ID that is unique to the call and can be used to correlate webhook events

call_session_id stringrequired

ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.

is_alive booleanrequired

Indicates whether the call is alive or not.

{
  "data": {
    "record_type": "string",
    "call_control_id": "AgDIxmoRX6QMuaIj_uXRXnPAXP0QlNfXczRrZvZakpWxBlpw48KyZQ==",
    "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1",
    "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1",
    "is_alive": true
  }
}

422: Error response

application/json

• Schema
• Example (from schema)

Schema

code stringrequired
title stringrequired
detail stringrequired

{
  "code": "90015",
  "title": "Invalid Call Control ID",
  "detail": "The call_control_id provided was not valid."
}

Loading...