latestOpenAPI 3.1.1Proprietary – Contact us for usage terms2026-08-20173183551.4 KB

9da73dd2f99e

channels

Toggle mute on a live call channel

Toggles the mute state on a live call channel. If the channel is currently unmuted, the participant will be muted (their audio is no longer transmitted to the other party). If already muted, they will be unmuted. This is a real-time telephony control — the effect is immediate and applies to the ongoing call.

The channelId identifies a specific participant's leg in the call. Use POST /calls/current to discover active channel IDs.

Permission: Calls Write required.

Monitoring: Required. This is a live call supervisory control. Returns 401 Unauthorized if Monitoring is OFF on your API key.

post/channels/{channelId}/events/mute/toggle

Path parameters

channelIdstring required

The unique identifier of the call channel. Use POST /calls/current to discover active channel IDs.

Response

Successfully processed — the mute toggle event has been applied to the channel.