Skip to main content

Moderate group call

POST 
/groupCallAdmin

Runs a moderator action in a group call, chosen with act. Moderators of the conversation may use every action, everyone else only raise_hand and lower_own_hand. Participants are named by their call identity, user_ and the user ID (user_-5 for a guest). Requires WebSocket version.

The actions:

  • lock_room, unlock_room: keep everyone but moderators from joining, or let them join again
  • set_broadcast_mode, set_participatory_mode: switch the call between broadcast and participatory mode
  • mute_all, unmute_all: mute or unmute everyone's microphone, or with identities only the people listed
  • end_call (3.2): end the call for everyone, taking out the people in identities
  • remove_participant: take identity out of the call. They can join again.
  • ban_participant (3.2): Remove and Ban from Calls. Takes identity out of the call and keeps them from the conversation's calls for duration minutes, and with chat also bans them from the conversation where that is offered (canBanFromChat of /groupCallStart: group conversations and chat rooms). Answers with the updated thread data. Lift the ban with /thread/{id}/callUnbanUser.
  • mute_participant, unmute_participant: stop identity from sending audio and video, or let them again
  • mute_mic, unmute_mic: mute or unmute the microphone of identity
  • promote_participant, demote_participant: in broadcast mode, let identity speak and show video, or make them a viewer again
  • pin_participant, unpin_participant: pin identity in the call, or unpin them
  • spotlight_participant, unspotlight_participant (3.2): put identity in the spotlight for everyone, up to four people, or take them out of it
  • ask_camera, ask_microphone, ask_camera_microphone (3.2): ask identity to turn on their camera, their microphone, or both in one ask. Once in 30 seconds for each moderator, person and device, and never yourself. Answers { "asked": true }.
  • raise_hand, lower_own_hand: raise or lower your own hand
  • lower_hand: lower the hand of identity

Request#

Responses#

Done. true for the room settings and end_call, the updated thread data for ban_participant, { "asked": true } for the asks, and the call server's answer for the other actions.