Call Commands

Transcription start

Changed on

Start real-time transcription. Transcription will stop on call hang-up, or can be initiated via the Transcription stop command.

Expected Webhooks:

  • call.transcription
post/calls/{call_control_id}/actions/transcription_start

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/calls/{call_control_id}/actions/transcription_start
  • Auth: HTTP bearer

Path parameters

call_control_idstring required

Unique identifier and token for controlling the call

Request body

transcription_engine'Google' | 'Telnyx' | 'Deepgram' | 'Azure' | 'xAI' | 'AssemblyAI' | 'Speechmatics' | 'Soniox' | 'Parakeet' | 'Humain' | 'Reson8' | 'Cohere' | 'A' | 'B'

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

client_statestring

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

transcription_tracksstring

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.

command_idstring

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

Example request

{
  "transcription_engine": "Google",
  "transcription_engine_config": {
    "transcription_engine": "Google",
    "language": "en"
  },
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901"
}

Response

Successful response upon making a call control command.

Example response

{
  "data": {
    "result": "ok"
  }
}

Changes

  • 279d149de88fRevision changes
    • info

      added the new ar enum value to the request property //

    • info

      added the new be enum value to the request property //

    • info

      added the new bg enum value to the request property //

    • info

      added the new bn enum value to the request property //

    • info

      added the new ca enum value to the request property //

    • info

      added the new cmn enum value to the request property //

    • info

      added the new cmn-Hans enum value to the request property //

    • info

      added the new cmn-Hant enum value to the request property //

    • info

      added the new cs enum value to the request property //

    • info

      added the new da enum value to the request property //

    • info

      added the new de enum value to the request property //

    • info

      added the new el enum value to the request property //

    • info

      added the new en-AU enum value to the request property //

    • info

      added the new en-GB enum value to the request property //

    • info

      added the new en-US enum value to the request property //

    • info

      added the new eo enum value to the request property //

    • info

      added the new es enum value to the request property //

    • info

      added the new et enum value to the request property //

    • info

      added the new fa enum value to the request property //

    • info

      added the new fi enum value to the request property //

    • info

      added the new fr enum value to the request property //

    • info

      added the new he enum value to the request property //

    • info

      added the new hi enum value to the request property //

    • info

      added the new hr enum value to the request property //

    • info

      added the new hu enum value to the request property //

    • info

      added the new ia enum value to the request property //

    • info

      added the new id enum value to the request property //

    • info

      added the new it enum value to the request property //

    • info

      added the new ja enum value to the request property //

    • info

      added the new ko enum value to the request property //

    • info

      added the new lt enum value to the request property //

    • info

      added the new lv enum value to the request property //

    • info

      added the new mr enum value to the request property //

    • info

      added the new ms enum value to the request property //

    • info

      added the new nl enum value to the request property //

    • info

      added the new no enum value to the request property //

    • info

      added the new pl enum value to the request property //

    • info

      added the new pt enum value to the request property //

    • info

      added the new ro enum value to the request property //

    • info

      added the new ru enum value to the request property //

    • info

      added the new sk enum value to the request property //

    • info

      added the new sl enum value to the request property //

    • info

      added the new speechmatics/linden-1 enum value to the request property //

    • info

      added the new sv enum value to the request property //

    • info

      added the new ta enum value to the request property //

    • info

      added the new th enum value to the request property //

    • info

      added the new tr enum value to the request property //

    • info

      added the new uk enum value to the request property //

    • info

      added the new ur enum value to the request property //

    • info

      added the new vi enum value to the request property //

    • info

      added the new yue enum value to the request property //

  • 4d2bad449eaeRevision changes
    • info

      added deepgram/nova-2-medical deepgram/nova-2-phonecall deepgram/nova-3-medical deepgram/flux deepgram/flux-multi discriminator mapping keys to the //// request property

    • info

      added to the //// request property oneOf list