channels
Toggle hold on a live call channel
Toggles the hold state on a live call channel. If the channel is currently active, the participant will be placed on hold (they hear hold music, their audio is paused). If already on hold, the call is resumed. This is a real-time telephony control — the effect is immediate.
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/hold/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 hold toggle event has been applied to the channel.