Sign in
Call Commands

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
post/calls/{call_control_id}/actions/transcription_start

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

Changed in 9 of the 99 revisions of this API.916

  • 1581f4d445661See the full diff
    • ○

      added the new omi-health/omi-med-stt-v1 enum value to the request property //

      request-property-enum-value-added

  • 4596ec306e592See the full diff
    • ○

      the request property default value changed from assemblyai/universal-streaming to assemblyai/universal-3-5-pro

      request-property-default-value-changed

    • ○

      added the new assemblyai/universal-3-5-pro enum value to the request property //

      request-property-enum-value-added

  • a6a61a29ecdd3See the full diff
    • ○

      added Cohere discriminator mapping keys to the request property

      request-property-discriminator-mapping-added

    • ○

      added the new Cohere enum value to the request property

      request-property-enum-value-added

    • ○

      added to the request property oneOf list

      request-property-one-of-added

    This revision also has 34 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1571b0380bd73See the full diff
    • ▲

      the response's body type changed from object to no type for status

      response-body-type-changed

    • ▲

      the / response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      the // response's property type changed from integer to string, and format from int32 to integer for status

      response-property-type-changed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379944See the full diff
    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the / response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from integer to int32 for status

      response-property-type-changed

    • ▲

      the /// response's property format changed from json-pointer to no format for status

      response-property-type-changed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 924fbdb1e5a13See the full diff
    • ○

      added Reson8 discriminator mapping keys to the request property

      request-property-discriminator-mapping-added

    • ○

      added the new Reson8 enum value to the request property

      request-property-enum-value-added

    • ○

      added to the request property oneOf list

      request-property-one-of-added

  • ce9e90fc16f33See the full diff
    • ○

      added Humain discriminator mapping keys to the request property

      request-property-discriminator-mapping-added

    • ○

      added the new Humain enum value to the request property

      request-property-enum-value-added

    • ○

      added to the request property oneOf list

      request-property-one-of-added

  • afc3349ad4f112See the full diff
    • ▲

      removed the enum value parakeet/tdt-0.6b-v3 of the request property //

      request-property-enum-value-removed

    • ○

      the request property default value changed from parakeet/tdt-0.6b-v3 to nvidia/parakeet-v3

      request-property-default-value-changed

    • ○

      added the new nvidia/parakeet-v3 enum value to the request property //

      request-property-enum-value-added

  • 224ed0d8a5c312See the full diff
    • ▲

      removed the enum value nvidia/parakeet-v3 of the request property //

      request-property-enum-value-removed

    • ○

      the request property default value changed from nvidia/parakeet-v3 to parakeet/tdt-0.6b-v3

      request-property-default-value-changed

    • ○

      added the new parakeet/tdt-0.6b-v3 enum value to the request property //

      request-property-enum-value-added

    This revision also has 111 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 99 revisions, 1 has no diff computed.