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

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.calls.actions.startNoiseSuppression('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

Start noise suppression request

​
client_state
string

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

Example:

"aGF2ZSBhIG5pY2UgZGF5ID1d"

​
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"

​
direction
enum<string>
default:inbound

The direction of the audio stream to be noise suppressed.

Available options:
inbound,
outbound,
both
Example:

"outbound"

​
noise_suppression_engine
enum<string>
default:Denoiser

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

Available options:
Denoiser,
DeepFilterNet
Example:

"Denoiser"

​
noise_suppression_engine_config
Noise Suppression Engine Configuration · object

Configuration parameters for noise suppression engines.

Response

Successful response upon making a call control command.

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