Mute all participants

POST/accounts/{account_id}/realtime/kit/{app_id}/meetings/{meeting_id}/active-session/mute-all

Mutes all participants of an active session for the given meeting ID.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Realtime AdminRealtime

Path ParametersExpand Collapse

account_id: string

The account identifier tag.

maxLength32

app_id: string

The app identifier tag.

meeting_id: string

Body ParametersJSONExpand Collapse

allow_unmute: optional boolean

if false, participants won’t be able to unmute themselves after they are muted

ReturnsExpand Collapse

data: optional object { action, muted_participants_count }

action: optional string

muted_participants_count: optional number

success: optional boolean

Mute all participants

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/realtime/kit/$APP_ID/meetings/$MEETING_ID/active-session/mute-all \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{}'

{
  "data": {
    "action": "action",
    "muted_participants_count": 0
  },
  "success": true
}

Returns Examples

{
  "data": {
    "action": "action",
    "muted_participants_count": 0
  },
  "success": true
}