Mute all participants

client.RealtimeKit.ActiveSession.MuteAllParticipants(ctx, appID, meetingID, params) (*ActiveSessionMuteAllParticipantsResponse, error)

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

appID string

The app identifier tag.

meetingID string

params ActiveSessionMuteAllParticipantsParams

AccountID param.Field[string]

Path param: The account identifier tag.

maxLength32

AllowUnmute param.Field[bool]Optional

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

ReturnsExpand Collapse

type ActiveSessionMuteAllParticipantsResponse struct{…}

Data ActiveSessionMuteAllParticipantsResponseDataOptional

Action stringOptional

MutedParticipantsCount float64Optional

Success boolOptional

Mute all participants

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/realtime_kit"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.RealtimeKit.ActiveSession.MuteAllParticipants(
    context.TODO(),
    "14a396e7-ca44-4937-bf1f-050a69118543",
    "meeting_id",
    realtime_kit.ActiveSessionMuteAllParticipantsParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Data)
}

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

Returns Examples

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