Mute all participants

realtime_kit.active_session.mute_all_participants(, ) -> ActiveSessionMuteAllParticipantsResponse

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

ParametersExpand Collapse

account_id: str

The account identifier tag.

maxLength32

app_id: str

The app identifier tag.

meeting_id: str

allow_unmute: Optional[bool]

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

ReturnsExpand Collapse

class ActiveSessionMuteAllParticipantsResponse: …

data: Optional[Data]

action: Optional[str]

muted_participants_count: Optional[float]

success: Optional[bool]

Mute all participants

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.realtime_kit.active_session.mute_all_participants(
    meeting_id="meeting_id",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    app_id="14a396e7-ca44-4937-bf1f-050a69118543",
)
print(response.data)

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

Returns Examples

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