Telnyx

JavaScript

import Telnyx from 'telnyx';

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

// Automatically fetches more pages as needed.
for await (const recordingResponseData of client.recordings.list()) {
  console.log(recordingResponseData.id);
}

{
  "data": [
    {
      "call_control_id": "v3:e-31OnvjEM7Y4wvxr3TKNk8M3QyLcGZPiUIzCGtwQtOtEjY-B0urkw",
      "call_leg_id": "84a97d76-e40f-11ed-9074-02420a0daa69",
      "call_session_id": "84a97d76-e40f-11ed-9074-02420a0daa69",
      "channels": "dual",
      "conference_id": "84a97d76-e40f-11ed-9074-02420a0daa69",
      "created_at": "2018-02-02T22:25:27.521Z",
      "download_urls": {
        "mp3": "<string>",
        "wav": "<string>"
      },
      "duration_millis": 60000,
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "record_type": "recording",
      "recording_started_at": "2019-01-23T18:10:02.574Z",
      "recording_ended_at": "2019-01-23T18:10:02.574Z",
      "source": "conference",
      "status": "completed",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

recordings

JavaScript

import Telnyx from 'telnyx';

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

// Automatically fetches more pages as needed.
for await (const recordingResponseData of client.recordings.list()) {
  console.log(recordingResponseData.id);
}

{
  "data": [
    {
      "call_control_id": "v3:e-31OnvjEM7Y4wvxr3TKNk8M3QyLcGZPiUIzCGtwQtOtEjY-B0urkw",
      "call_leg_id": "84a97d76-e40f-11ed-9074-02420a0daa69",
      "call_session_id": "84a97d76-e40f-11ed-9074-02420a0daa69",
      "channels": "dual",
      "conference_id": "84a97d76-e40f-11ed-9074-02420a0daa69",
      "created_at": "2018-02-02T22:25:27.521Z",
      "download_urls": {
        "mp3": "<string>",
        "wav": "<string>"
      },
      "duration_millis": 60000,
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "record_type": "recording",
      "recording_started_at": "2019-01-23T18:10:02.574Z",
      "recording_ended_at": "2019-01-23T18:10:02.574Z",
      "source": "conference",
      "status": "completed",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

page

object

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

Show child attributes

page[size]

integer

default:20

The size of the page.

Required range: 1 <= x <= 250

page[number]

integer

default:1

The page number to load.

Required range: x >= 1

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[conference_id], filter[created_at][gte], filter[created_at][lte], filter[call_leg_id], filter[call_session_id], filter[from], filter[to], filter[connection_id], filter[sip_call_id]

Show child attributes

filter[conference_id]

string

Returns only recordings associated with a given conference.

Example:

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

filter[created_at]

object

Show child attributes

filter[created_at][gte]

string

Returns only recordings created later than or at given ISO 8601 datetime.

Example:

"2019-03-29T11:10:00Z"

filter[created_at][lte]

string

Returns only recordings created earlier than or at given ISO 8601 datetime.

Example:

"2019-03-29T11:10:00Z"

filter[call_leg_id]

string<uuid>

If present, recordings will be filtered to those with a matching call_leg_id.

Example:

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

filter[call_session_id]

string<uuid>

If present, recordings will be filtered to those with a matching call_session_id.

Example:

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

filter[from]

string

If present, recordings will be filtered to those with a matching from attribute (case-sensitive).

Example:

"1234567890"

filter[to]

string

If present, recordings will be filtered to those with a matching to attribute (case-sensitive).

Example:

"1234567890"

filter[connection_id]

string

If present, recordings will be filtered to those with a matching connection_id attribute (case-sensitive).

Example:

"175237942907135762"

filter[sip_call_id]

string

If present, recordings will be filtered to those with a matching sip_call_id attribute. Matching is case-sensitive

Example:

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

Response

A response containing multiple recordings.

data

RecordingResponseData · object[]

Show child attributes

data.call_control_id

string

Unique identifier and token for controlling the call.

Example:

"v3:e-31OnvjEM7Y4wvxr3TKNk8M3QyLcGZPiUIzCGtwQtOtEjY-B0urkw"

data.call_leg_id

string

ID unique to the call leg (used to correlate webhook events).

Example:

"84a97d76-e40f-11ed-9074-02420a0daa69"

data.call_session_id

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.

Example:

"84a97d76-e40f-11ed-9074-02420a0daa69"

data.channels

enum<string>

When dual, the final audio file has the first leg on channel A, and the rest on channel B.

Available options:

single,

dual

Example:

"dual"

data.conference_id

string

Uniquely identifies the conference.

Example:

"84a97d76-e40f-11ed-9074-02420a0daa69"

data.created_at

string

ISO 8601 formatted date indicating when the resource was created.

Example:

"2018-02-02T22:25:27.521Z"

data.download_urls

object

Links to download the recording files.

Show child attributes

data.download_urls.mp3

string

Link to download the recording in mp3 format.

data.download_urls.wav

string

Link to download the recording in wav format.

data.duration_millis

integer<int32>

The duration of the recording in milliseconds.

Example:

60000

data.id

string

Uniquely identifies the recording.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

data.record_type

enum<string>

Available options:

recording

Example:

"recording"

data.recording_started_at

string

ISO 8601 formatted date of when the recording started.

Example:

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

data.recording_ended_at

string

ISO 8601 formatted date of when the recording ended.

Example:

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

data.source

enum<string>

The kind of event that led to this recording being created.

Available options:

conference,

call

Example:

"conference"

data.status

enum<string>

The status of the recording. Only completed recordings are currently supported.

Available options:

completed

Example:

"completed"

data.updated_at

string

ISO 8601 formatted date indicating when the resource was updated.

Example:

"2018-02-02T22:25:27.521Z"

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

List all call recordings

Authorizations

Query Parameters

Response