TeXML REST Commands

Fetch multiple recording resources

Changed on

Returns multiple recording resources for an account.

get/texml/Accounts/{account_sid}/Recordings.json

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/texml/Accounts/{account_sid}/Recordings.json
  • Auth: HTTP bearer

Path parameters

account_sidstring required
Example:f5586561-8ff0-4291-a51b-c7dfe4139ff9

The UUID of the Telnyx account that owns the resource, for example f5586561-8ff0-4291-a51b-c7dfe4139ff9. The account_sid path segment is kept for Twilio API compatibility, but the value is a Telnyx account UUID, not a Twilio AC... SID. It must match the account that owns the API key used to authenticate the request, otherwise the endpoint returns 404. The same value is sent as AccountSid in TeXML webhooks.

Query parameters

Pageinteger

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

PageSizeinteger

The number of records to be displayed on a page

DateCreatedstring date-time
Example:2023-05-22T00:00:00Z

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.

Response

Successful Get Call Recordings Response

endinteger

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

first_page_uristring uri

Relative uri to the first page of the query results

previous_page_uristring uri

Relative uri to the previous page of the query results

next_page_uristring

Relative uri to the next page of the query results

pageinteger

Current page number, zero-indexed.

page_sizeinteger

The number of items on the page

startinteger

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

uristring

The URI of the current page.

Example response

{
  "recordings": [
    {
      "account_sid": "61bf923e-5e4d-4595-a110-56190ea18a1b",
      "call_sid": "v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA",
      "conference_sid": "cd5a70f4-759b-4d5e-9c06-88c00f16f3c1",
      "channels": 1,
      "date_created": "2023-08-11T19:12:11Z",
      "date_updated": "2023-08-11T19:12:11Z",
      "start_time": "2023-08-11T19:12:11Z",
      "duration": "12",
      "sid": "e9cea0be-7dbd-4b98-98b1-c0089d9d43b0",
      "status": "paused",
      "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,
  "next_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=1&PageSize=1",
  "page_size": 20,
  "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings.json?Page=0&PageSize=1"
}

Changes

  • a6a61a29ecddRevision changes
    • warning

      added the new 1.00 enum value to the // response property for the response status

    • warning

      added the new 2.00 enum value to the // response property for the response status

    • info

      the response's property default value changed from 2 to 2 for the status

    • info

      removed the 1 enum value from the // response property for the response status

    • info

      removed the 2 enum value from the // response property for the response status

  • 1571b0380bd7Revision changes
    • warning

      added the new 1 enum value to the // response property for the response status

    • warning

      added the new 2 enum value to the // response property for the response status

    • info

      the response's property default value changed from 2 to 2 for the status

    • info

      removed the 1.00 enum value from the // response property for the response status

    • info

      removed the 2.00 enum value from the // response property for the response status