Recording Transcriptions

Retrieve a Transcription

Changed on

Retrieves one saved recording transcription by SID so you can inspect the resulting text and processing outcome. Use List all Transcriptions to discover SIDs; this is not a live transcription stream.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.

Learn more about API scopes.

get/Accounts/{AccountSid}/Transcriptions/{Sid}

Request

  • Base URL
    https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01
  • URL
    https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Transcriptions/{Sid}
  • Auth
    HTTP basic

Path parameters

AccountSidstring uuid required

Universal Unique Identifier.

The unique identifier for the account that created this transcription.

Sidstring uuid required

Universal Unique Identifier.

The unique identifier for the transcription.

Response

The request has succeeded.

sidstring uuid required

Universal Unique Identifier.

account_sidstring uuid required

Universal Unique Identifier.

api_versionstring required

The version of the SignalWire API.

recording_sidstring uuid required

Universal Unique Identifier.

date_createdstring required

The date, in RFC 2822 format, this transcription was created.

date_updatedstring required

The date, in RFC 2822 format, this transcription was updated.

durationinteger required

The duration, in seconds, of the transcribed audio.

pricestring nullable required

The charge for the transcription. Null if cost has not been calculated.

price_unitstring required

The currency, in ISO 4217 format, for the price of the transcription.

statusstring required

The status of the transcription. Always 'completed' for transcriptions returned by the API.

transcription_textstring nullable required

The text content of the transcription. Null if transcription text is not available.

typestring required

The type of the transcription. Currently always an empty string.

uristring required

The URI of this resource, relative to the API base URL.

Example response

{
  "api_version": "2010-04-01",
  "date_created": "Thu, 27 Sep 2018 02:00:00 +0000",
  "date_updated": "Fri, 28 Sep 2018 03:00:00 +0000",
  "duration": 60,
  "price": "-0.00025",
  "price_unit": "USD",
  "status": "completed",
  "transcription_text": "Hello, this is a test transcription.",
  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/Transcriptions/b3877c40-da60-4998-90ad-b792e98472tr.json"
}

Changes

  • 2916d5e3072eRevision changes
    • breaking

      the response's property type changed from string to no type, and format from uuid to no format for status

    • breaking

      the response's property type changed from string to no type, and format from uuid to no format for status

    • breaking

      the response's property type changed from string to no type, and format from uuid to no format for status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

  • 5344c0c93a4cRevision changes
    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status