Skip to main content

Fetch multiple recording resources

GET 
/texml/Accounts/:account_sid/Recordings.json

Returns multiple recording resources for an account.

Request​

Path Parameters

    account_sid stringrequired

    The id of the account the resource belongs to.

Query Parameters

    Page integer

    The number of the page to be displayed, zero-indexed, should be used in conjuction with PageToken.

    Example: 1
    PageSize integer

    The number of records to be displayed on a page

    Example: 10
    DateCreated datetime-iso8601

    Filters recording by the creation date. Expected format is ISO8601 date or date-time, ie. {YYYY}-{MM}-{DD} or {YYYY}-{MM}-{DD}T{hh}:{mm}:{ss}Z. Also accepts inequality operators, e.g. DateCreated>=2023-05-22.

Responses​

200: Successful Get Call Recordings Response

Schema

    recordings

    object[]

  • Array [

    • account_sid AccountSid (string)
    call_sid CallControlId (string)
    conference_sid uuidnullable
    channels TwimlRecordingChannels (integer)

    Possible values: [1, 2]

    Default value: 2

    date_created datetime-rfc2822
    date_updated datetime-rfc2822
    start_time datetime-rfc2822
    duration TexmlRecordingDuration (string)nullable

    The duration of this recording, given in seconds.

    sid TexmlSid (string)

    Identifier of a resource.

    source RecordingSource (string)

    Possible values: [StartCallRecordingAPI, StartConferenceRecordingAPI, OutboundAPI, DialVerb, Conference, RecordVerb, Trunking]

    Defines how the recording was created.

    status TexmlRecordingStatus (string)

    Possible values: [in-progress, completed, paused, stopped]

    error_code TexmlErrorCode (string)nullable

    subresources_uris

    object

    Subresources details for a recording if available.

    transcriptions urinullable

    Subresources details for a recording if available.

    uri string

    The relative URI for this recording resource.

    media_url uri

  • ]

    • end integer

    The number of the last element on the page, zero-indexed.

    first_page_uri uri

    Relative uri to the first page of the query results

    previous_page_uri uri

    Relative uri to the previous page of the query results

    next_page_uri string

    Relative uri to the next page of the query results

    page integer

    Current page number, zero-indexed.

    page_size integer

    The number of items on the page

    start integer

    The number of the first element on the page, zero-indexed.

    uri string

    The URI of the current page.

404: Resource not found

Schema

    errors

    object[]

  • Array [

    • detail string

  • ]

Request samples

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

Response samples

{
  "recordings": [
    {
      "account_sid": "61bf923e-5e4d-4595-a110-56190ea18a1b",
      "call_sid": "v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA",
      "conference_sid": "cd5a70f4-759b-4d5e-9c06-88c00f16f3c1",
      "channels": 1,
      "date_created": "Fri, 11 Aug 2023 19:12:11 +0000",
      "date_updated": "Fri, 11 Aug 2023 19:12:11 +0000",
      "start_time": "Fri, 11 Aug 2023 19:12:11 +0000",
      "duration": "12",
      "sid": "e9cea0be-7dbd-4b98-98b1-c0089d9d43b0",
      "source": "StartCallRecordingAPI",
      "status": "paused",
      "error_code": null,
      "subresources_uris": {
        "transcriptions": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings/b08f0fa1-a32c-4218-b3b5-9cf78941ccac/Transcriptions.json"
      },
      "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings/b08f0fa1-a32c-4218-b3b5-9cf78941ccac.json",
      "media_url": "http://recordings.com/mp3/filename.mp3"
    }
  ],
  "end": 19,
  "first_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings.json?Page=0&PageSize=1",
  "previous_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings.json?Page=0&PageSize=1",
  "next_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=1&PageSize=1",
  "page": 0,
  "page_size": 20,
  "start": 0,
  "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings.json?Page=0&PageSize=1"
}