Skip to main content
POST
/
calls
/
{call_control_id}
/
actions
/
transcription_start
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const response = await client.calls.actions.startTranscription('call_control_id');

console.log(response.data);
{
  "data": {
    "result": "ok"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
call_control_id
string
required

Unique identifier and token for controlling the call

Body

application/json

Transcription start request

​
transcription_engine
enum<string>
default:Google

Engine to use for speech recognition. Legacy values A - Google, B - Telnyx are supported for backward compatibility.

Available options:
Google,
Telnyx,
Deepgram,
A,
B
Example:

"Google"

​
transcription_engine_config
Transcription engine Google config · object
  • Transcription engine Google config
  • Transcription engine Telnyx config
  • Transcription engine Deepgram config
  • Transcription engine A config
  • Transcription engine B config
​
client_state
string

Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.

Example:

"aGF2ZSBhIG5pY2UgZGF5ID1d"

​
transcription_tracks
string
default:inbound

Indicates which leg of the call will be transcribed. Use inbound for the leg that requested the transcription, outbound for the other leg, and both for both legs of the call. Will default to inbound.

Example:

"both"

​
command_id
string

Use this field to avoid duplicate commands. Telnyx will ignore any command with the same command_id for the same call_control_id.

Example:

"891510ac-f3e4-11e8-af5b-de00688a4901"

Response

Successful response upon making a call control command.

​
data
Call Control Command Result · object
Example:
{ "result": "ok" }