Call Commands

Noise Suppression Start (BETA)

Changed on

Start noise suppression on an active call to reduce background noise. This feature is currently in beta.

post/calls/{call_control_id}/actions/suppression_start

Request

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

Path parameters

call_control_idstring required

Unique identifier and token for controlling the call

Request body

client_statestring

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

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.

direction'inbound' | 'outbound' | 'both'

The direction of the audio stream to be noise suppressed.

noise_suppression_engine'Denoiser' | 'DeepFilterNet' | 'Krisp' | 'AiCoustics' | 'aic_l_quail' | 'aic_l_rook' | 'aic_s_quail' | 'aic_s_rook' | 'quail_voice_focus_s' | 'quail_voice_focus_xs'

The engine to use for noise suppression. For backward compatibility, engines A, B, C, and D are also supported, but are deprecated: A - Denoiser B - DeepFilterNet C - Krisp D - AiCoustics

Example request

{
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901",
  "direction": "both",
  "noise_suppression_engine": "DeepFilterNet",
  "noise_suppression_engine_config": {
    "attenuation_limit": 100
  }
}

Response

Successful response upon making a call control command.

Example response

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

Changes

  • 9e3761de1075Revision changes
    • info

      added the new aic_l_quail enum value to the request property

    • info

      added the new aic_l_rook enum value to the request property

    • info

      added the new aic_s_quail enum value to the request property

    • info

      added the new aic_s_rook enum value to the request property

    • info

      added the new quail_voice_focus_s enum value to the request property

    • info

      added the new quail_voice_focus_xs enum value to the request property