Skip to main content

Controlling an Active Session

An active session (ongoing meeting) can be controlled programatically using Active Session APIs. For now, you can do following things in an Active Session.

  • Fetch active session details.
  • Kick one or more participants.
  • Kick all participants.
  • Mute one or more participants.
  • Mute all participants.
  • Create a poll.

Get Active Session details

You can get an active session of a meeting using meetingId. Refer to GET active session endpoint under v2 API Reference.

Kick one or more participants

You can kick one or multiple participants from an active session using participant_ids or custom_participant_ids.

custom_participant_id is called clientSpecificId in v1 and it's the same id that you pass in body of Add Participant Endpoint

Refer to Kick Participant endpoint to see complete details.

Kick all participants

All participants can be kicked out from an active session using Kick all endpoint

Mute one or more participants

Similar to kicking participants, one or multiple participants can be muted in an active session using participant_ids or custom_participant_ids. Refer to Mute participants endpoint to see request body and response.

Mute all participants

All participants can be muted in an active session using Mute all endpoint. You can also specify if participants can unmute themselves or not using allow_unmute option in request body. Refer to Mute all endpoint to see complete details.

Create a poll

You can also create a poll in an active session programatically. Poll will always be created under your organization's name. You can specify different options while creating poll like hide_votes, anonymous etc. Refer to Create Poll endpoint to see complete details.

You can see list of all endpoints for active session in activesession section under v2 API Reference.