1. Tasks
  2. Voice Mute

Tasks

Voice Mute

Mutes the caller on a live voice call, so the assistant stops hearing them. Useful for putting a caller on hold or ignoring background noise while the stub does something.

The call stays up, and the assistant can still speak. The caller stays muted until Voice Unmute.

The same command is available as a mute voice notification. The caller's channel can also mute the caller, eg with a mute button.

Basic usage

loading...

Parameters

voice_session_uuid
optional
string

The voice call to send the command to. It must belong to this stub.

Default: the stub's live voice call

Result

loading...

Properties

payload.voice_session_uuid
string

The voice call the command was sent to.

Errors

message Meaning
no_active_voice_session The stub has no live voice call, or voice_session_uuid doesn't belong to this stub
voice_session_not_active The call is already ending