This API returns the current status of a transcription request created by POST /objects/OBJECT_ID/transcribe.
Transcription is asynchronous – poll this API until the status is terminal.
Statuses:
- accepted – the request was received and queued.
- downloading – the recording is being fetched.
- storing – the recording is being stored on the conversation.
- transcribing – the recording was sent to the transcription engine.
- completed – the transcript was written into the conversation (terminal).
- failed – the request could not be processed (terminal, includes an error).
- transcription_failed – the transcription engine failed (terminal, includes an error).
(GET) /objects/OBJECT_ID/transcribe/REQUEST_ID
Example:
https://api.commbox.io/objects/293854/transcribe/req_8f3a12c47b9e4d05
API key is needed to authorize requests. You can get your API key via the management console.
A Bearer Token is needed to be set in the Authorization header of every API call.
For additional support you can contact us.
Object Id is a CommBox generated number for the conversation.
The transcription request Id returned by the submit API.
Operation successful
A CommBox generated identifier for the transcription request.
A CommBox generated number for the conversation.
A CommBox generated number for the call-recording activity. Returned once the recording exists on the conversation.
Current status of the request – accepted, downloading, storing, transcribing, completed, failed or transcription_failed.
Returned only for the failed and transcription_failed statuses.
Machine-readable error code.
Bad Request - The request could not be understood by the server. Incoming parameters might not be valid
Unauthorized - The supplied credentials, if any, are not sufficient to access the resource
Not found - The transcription request was not found for this conversation
Too Many Requests - Too many requests have been made in a short period of time (Throttling)
Server Error - The server could not return the representation due to an internal server error
Not Implemented - The requested operation is not supported