Retrieve a Transcription

View as Markdown

Retrieve a single recording transcription.

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.

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

AccountSidstringRequiredformat: "uuid"
The unique identifier for the account that created this transcription.
SidstringRequiredformat: "uuid"
The unique identifier for the transcription.

Response

The request has succeeded.
sidstringformat: "uuid"
The unique identifier for the transcription.
account_sidstringformat: "uuid"
The unique identifier for the account that created this transcription.
api_versionstring
The version of the SignalWire API.
recording_sidstringformat: "uuid"
The unique identifier for the recording that this transcription was created from.
date_createdstring
The date, in RFC 2822 format, this transcription was created.
date_updatedstring
The date, in RFC 2822 format, this transcription was updated.
durationinteger>=0
The duration, in seconds, of the transcribed audio.
pricestring or null
The charge for the transcription. Null if cost has not been calculated.
price_unitstring
The currency, in ISO 4217 format, for the price of the transcription.
statusstring
The status of the transcription. Always 'completed' for transcriptions returned by the API.
transcription_textstring or null
The text content of the transcription. Null if transcription text is not available.
typestring
The type of the transcription. Currently always an empty string.
uristring
The URI of this resource, relative to the API base URL.

Errors