Recording Transcriptions

Retrieve a Transcription

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}

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

Changed in 5 of the 40 revisions of this API.1228

  • 2916d5e3072e33See the full diff
    • the account_sid response's property type/format changed from string/uuid to / for status 200

      response-property-type-changed

    • the recording_sid response's property type/format changed from string/uuid to / for status 200

      response-property-type-changed

    • the sid response's property type/format changed from string/uuid to / for status 200

      response-property-type-changed

    • added uuid to the account_sid response property allOf list for the response status 200

      response-property-all-of-added

    • added uuid to the recording_sid response property allOf list for the response status 200

      response-property-all-of-added

    • added uuid to the sid response property allOf list for the response status 200

      response-property-all-of-added

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

      response-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

    • response property price list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property transcription_text list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

  • d5fbaaddfa3e415See the full diff
    • the response property price became nullable for the status 200

      response-property-became-nullable

    • the response property transcription_text became nullable for the status 200

      response-property-became-nullable

    • the duration response's property type/format changed from string/ to integer/int32 for status 200

      response-property-type-changed

    • the status response's property type/format changed from / to string/ for status 200

      response-property-type-changed

    • added the non-success response with the status 400

      response-non-success-status-added

    • removed TranscriptionStatus from the status response property allOf list for the response status 200

      response-property-all-of-removed

    • the response property account_sid became required for the status 200

      response-property-became-required

    • the response property api_version became required for the status 200

      response-property-became-required

    • the response property date_created became required for the status 200

      response-property-became-required

    • the response property date_updated became required for the status 200

      response-property-became-required

    • the response property duration became required for the status 200

      response-property-became-required

    • the response property price became required for the status 200

      response-property-became-required

    • the response property price_unit became required for the status 200

      response-property-became-required

    • the response property recording_sid became required for the status 200

      response-property-became-required

    • the response property sid became required for the status 200

      response-property-became-required

    • the response property status became required for the status 200

      response-property-became-required

    • the response property transcription_text became required for the status 200

      response-property-became-required

    • the response property type became required for the status 200

      response-property-became-required

    • the response property uri became required for the status 200

      response-property-became-required

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3c88f14db21e36See the full diff
    • added the new path request parameter AccountSid

      new-request-path-parameter

    • added the new path request parameter Sid

      new-request-path-parameter

    • the status response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • added the non-success response with the status 401

      response-non-success-status-added

    • added the non-success response with the status 404

      response-non-success-status-added

    • added TranscriptionStatus to the status response property allOf list for the response status 200

      response-property-all-of-added

    • removed the completed enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • removed the failed enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • removed the in-progress enum value from the status response property for the response status 200

      response-property-enum-value-removed

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog