Skip to main content

List all call recordings

GET 
/recordings

Returns a list of your call recordings.

Request​

Query Parameters

    filter[conference_id] string

    Returns only recordings associated with a given conference

    filter[created_at][gte] string

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

    filter[created_at][lte] string

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

    filter[call_leg_id] uuid

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

    filter[call_session_id] uuid

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

    filter[from] string

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

    filter[to] string

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

    filter[connection_id] string

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

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

Responses​

200: A response with recordings.

Schema

    data

    object[]

  • Array [

    • data

    object

    call_control_id string

    Unique identifier and token for controlling the call.

    call_leg_id string

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

    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.

    channels string

    Possible values: [single, dual]

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

    conference_id string

    Uniquely identifies the conference.

    created_at string

    ISO 8601 formatted date indicating when the resource was created.

    download_urls

    object

    The links to download the recording files.

    mp3 string

    Link to download the recording in mp3 format.

    wav string

    Link to download the recording in wav format.

    The links to download the recording files.

    duration_millis int32

    The duration of the recording in milliseconds.

    id string

    Uniquely identifies the recording.

    record_type string

    Possible values: [recording]

    recording_started_at string

    ISO 8601 formatted date of when the recording started.

    recording_ended_at string

    ISO 8601 formatted date of when the recording ended.

    source string

    Possible values: [conference, call]

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

    status string

    Possible values: [completed]

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

    updated_at string

    ISO 8601 formatted date indicating when the resource was updated.

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

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

  • ]

Request samples

curl -L 'https://api.telnyx.com/v2/recordings' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "data": [
    {
      "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,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}