Skip to main content

Transcription start

POST 

/calls/:call_control_id/actions/transcription_start

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

Expected Webhooks:

  • call.transcription

Request

Path Parameters

    call_control_id stringrequired

    Unique identifier and token for controlling the call

Body

required

Transcription start request

    transcription_engine string

    Possible values: [A, B]

    Default value: A

    Engine to use for speech recognition. A - google, B - telnyx.

    language string

    Possible values: [de, en, es, fr, it, pl]

    Default value: en

    Language to use for speech recognition

    interim_results boolean

    Default value: false

    Whether to send also interim results. If set to false, only final results will be sent. Applies to google engine only.

    client_state string

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

    transcription_tracks string

    Default value: 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.

    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.

Responses

200: Successful response upon making a call control command.

Schema

    data

    object

    result string

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

  • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object
  • ]

Callbacks

Loading...