Documentation Index

Fetch the complete documentation index at: https://help.commbox.io/llms.txt

Use this file to discover all available pages before exploring further.

Get Transcription Request Status

Prev
Get
/objects/{OBJECT_ID}/transcribe/{REQUEST_ID}

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).
Required path params are the Object (conversation) Id and the Request Id.

(GET) /objects/OBJECT_ID/transcribe/REQUEST_ID

Example:
https://api.commbox.io/objects/293854/transcribe/req_8f3a12c47b9e4d05
Security
HTTP
Type bearer

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.

Path parameters
OBJECT_ID
Required

Object Id is a CommBox generated number for the conversation.

REQUEST_ID
Required

The transcription request Id returned by the submit API.

Responses
200

Operation successful

Expand All
object
status
string
Example200
description
string
ExampleOperation successful
response_time
string
Example2024-08-06T07:53:11.4471902Z
data
object
request_id
string

A CommBox generated identifier for the transcription request.

Examplereq_8f3a12c47b9e4d05
object_id
integer

A CommBox generated number for the conversation.

Example293854
activity_id
integer

A CommBox generated number for the call-recording activity. Returned once the recording exists on the conversation.

Example982310
status
string

Current status of the request – accepted, downloading, storing, transcribing, completed, failed or transcription_failed.

Examplecompleted
created_at
string
Example2024-08-06T07:51:52.2581942Z
updated_at
string
Example2024-08-06T07:53:04.1180735Z
error
object

Returned only for the failed and transcription_failed statuses.

code
string

Machine-readable error code.

Exampledownload_failed
message
string
ExampleThe recording could not be downloaded.
400

Bad Request - The request could not be understood by the server. Incoming parameters might not be valid

401

Unauthorized - The supplied credentials, if any, are not sufficient to access the resource

404

Not found - The transcription request was not found for this conversation

429

Too Many Requests - Too many requests have been made in a short period of time (Throttling)

500

Server Error - The server could not return the representation due to an internal server error

501

Not Implemented - The requested operation is not supported