Telnyx

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.calls.retrieveStatus('call_control_id');

console.log(response.data);

{
  "data": {
    "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
    "call_leg_id": "2dc6fc34-f9e0-11ea-b68e-02420a0f7768",
    "call_session_id": "2dc1b3c8-f9e0-11ea-bc5a-02420a0f7768",
    "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
    "is_alive": false,
    "call_duration": 50,
    "start_time": "2019-01-23T18:10:02.574Z",
    "end_time": "2019-01-23T18:11:52.574Z",
    "record_type": "call"
  }
}

GET

calls

{call_control_id}

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.calls.retrieveStatus('call_control_id');

console.log(response.data);

{
  "data": {
    "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
    "call_leg_id": "2dc6fc34-f9e0-11ea-b68e-02420a0f7768",
    "call_session_id": "2dc1b3c8-f9e0-11ea-bc5a-02420a0f7768",
    "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
    "is_alive": false,
    "call_duration": 50,
    "start_time": "2019-01-23T18:10:02.574Z",
    "end_time": "2019-01-23T18:11:52.574Z",
    "record_type": "call"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

call_control_id

string

required

Unique identifier and token for controlling the call

Response

Successful response with details about a call status.

data

Call · object

Show child attributes

data.record_type

enum<string>

required

Available options:

call

Example:

"call"

data.call_session_id

string

required

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

Example:

"428c31b6-7af4-4bcb-b68e-5013ef9657c1"

data.call_leg_id

string

required

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

Example:

"428c31b6-7af4-4bcb-b7f5-5013ef9657c1"

data.call_control_id

string

required

Unique identifier and token for controlling the call.

Example:

"v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg"

data.is_alive

boolean

required

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

Example:

true

data.client_state

string

State received from a command.

Example:

"aGF2ZSBhIG5pY2UgZGF5ID1d"

data.call_duration

integer

Indicates the duration of the call in seconds

Example:

50

data.start_time

string

ISO 8601 formatted date indicating when the call started

Example:

"2019-01-23T18:10:02.574Z"

data.end_time

string

ISO 8601 formatted date indicating when the call ended. Only present when the call is not alive

Example:

"2019-01-23T18:11:52.574Z"

Example:

{
  "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
  "call_leg_id": "2dc6fc34-f9e0-11ea-b68e-02420a0f7768",
  "call_session_id": "2dc1b3c8-f9e0-11ea-bc5a-02420a0f7768",
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "is_alive": false,
  "call_duration": 50,
  "start_time": "2019-01-23T18:10:02.574Z",
  "end_time": "2019-01-23T18:11:52.574Z",
  "record_type": "call"
}

Transfer call List all active calls for given connection

⌘I

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

Retrieve a call status

Authorizations

Path Parameters

Response