Skip to main content

Retrieve a call status

GET 
/calls/:call_control_id

Returns the status of a call (data is available 10 minutes after call ended).

Request​

Path Parameters

    call_control_id stringrequired

    Unique identifier and token for controlling the call

Responses​

200: Successful response with details about a call status.

Schema

    data

    object

    record_type stringrequired

    Possible values: [call]

    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

    call_leg_id stringrequired

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

    call_control_id stringrequired

    Unique identifier and token for controlling the call.

    is_alive booleanrequired

    Indicates whether the call is alive or not. For Dial command it will always be false (dialing is asynchronous).

    client_state string

    State received from a command.

    call_duration integer

    Indicates the duration of the call in seconds

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

    • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object

  • ]

Loading...