Skip to main content

List recording transcriptions

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

Returns multiple recording transcription resources for an account.

Request ​

Path Parameters

    account_sid stringrequired

    The id of the account the resource belongs to.

Query Parameters

    PageToken string

    Used to request the next page of results.

    PageSize integer

    The number of records to be displayed on a page

    Example: 10

Responses ​

200: Successful list Recording Transcriptions Response

Schema

    transcriptions

    object[]

  • Array [

    • account_sid AccountSid (string)
    call_sid CallControlId (string)
    api_version string

    The version of the API that was used to make the request.

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

    The duration of this recording, given in seconds.

    sid TexmlSid (string)

    Identifier of a resource.

    recording_sid TexmlSid (string)

    Identifier of a resource.

    status string

    Possible values: [in-progress, completed]

    The status of the recording transcriptions. The transcription text will be available only when the status is completed.

    transcription_text string

    The recording's transcribed text

    uri string

    The relative URI for the recording transcription resource.

  • ]

    • 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/Transcriptions.json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "transcriptions": [
    {
      "account_sid": "61bf923e-5e4d-4595-a110-56190ea18a1b",
      "call_sid": "v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA",
      "api_version": "2010-04-01",
      "date_created": "Fri, 11 Aug 2023 19:12:11 +0000",
      "date_updated": "Fri, 11 Aug 2023 19:12:11 +0000",
      "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,
  "first_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Transcriptions.json?Page=0&PageSize=1",
  "previous_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Transcriptions.json?PageToken=MZQTDUHX&PageSize=1",
  "next_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Transcriptions.json?PageToken=KRWXZPO&PageSize=1",
  "page": 0,
  "page_size": 20,
  "start": 0,
  "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Transcriptions.json?PageToken=YTBNAXPI&PageSize=1"
}