REST Client MethodsRecording Transcriptions

Retrieve

View as Markdown

Use this endpoint for the Recording Transcriptions method to retrieve a single recording transcription.

Path parameters

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

Response

sidstringRequiredformat: "uuid"
The unique identifier for the transcription.
account_sidstringRequiredformat: "uuid"
The unique identifier for the account that created this transcription.
api_versionstringRequired
The version of the SignalWire API.
recording_sidstringRequiredformat: "uuid"
The unique identifier for the recording that this transcription was created from.
date_createdstringRequired
The date, in RFC 2822 format, this transcription was created.
date_updatedstringRequired
The date, in RFC 2822 format, this transcription was updated.
durationintegerRequired>=0
The duration, in seconds, of the transcribed audio.
pricestring or nullRequired
The charge for the transcription. Null if cost has not been calculated.
price_unitstringRequired
The currency, in ISO 4217 format, for the price of the transcription.
statusstringRequired
The status of the transcription. Always 'completed' for transcriptions returned by the API.
transcription_textstring or nullRequired
The text content of the transcription. Null if transcription text is not available.
typestringRequired
The type of the transcription. Currently always an empty string.
uristringRequired
The URI of this resource, relative to the API base URL.

Request examples

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.transcriptions('Sid')
5      .fetch()
6      .then(transcription => console.log(transcription.dateCreated))
7      .done();