TeXML REST Commands

List recording transcriptions

Returns multiple recording transcription resources for an account.

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

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/texml/Accounts/{account_sid}/Transcriptions.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

PageTokenstring

Used to request the next page of results.

PageSizeinteger

The number of records to be displayed on a page

Response

Successful list Recording Transcriptions 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

{
  "transcriptions": [
    {
      "account_sid": "61bf923e-5e4d-4595-a110-56190ea18a1b",
      "call_sid": "v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA",
      "api_version": "2010-04-01",
      "date_created": "2023-08-11T19:12:11Z",
      "date_updated": "2023-08-11T19:12:11Z",
      "duration": "12",
      "sid": "e9cea0be-7dbd-4b98-98b1-c0089d9d43b0",
      "recording_sid": "e9cea0be-7dbd-4b98-98b1-c0089d9d43b0",
      "status": "completed",
      "transcription_text": "Good morning, how may I help you?",
      "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Transcriptions/b08f0fa1-a32c-4218-b3b5-9cf78941ccac.json"
    }
  ],
  "end": 1,
  "next_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Transcriptions.json?PageToken=KRWXZPO&PageSize=1",
  "page_size": 20,
  "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Transcriptions.json?PageToken=YTBNAXPI&PageSize=1"
}

Changes

No operation changes recorded.