Call Information V1

Call Information operations

Call Status

Returns the status of a given call.

SecuritybasicAuth or bearerAuth
Request
path Parameters
call_control_id
required
string

Unique identifier and token for controlling the call

Responses
200

Successful response

Response Schema: application/json
object (CallControlStatusResponse)
record_type
required
string

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

call_control_id
required
string

Unique identifier and token for controlling the call

call_leg_id
required
string

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

call_session_id
required
string

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
required
boolean

Indicates whether the call is alive or not.

422

Error response

Response Schema: application/json
code
required
string
title
required
string
detail
required
string
get/calls/{call_control_id}/status
Request samples 
Response samples 
application/json
{
  • "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
    }
}