RoomParticipant

A RoomParticipant represents a Session’s participation in one Room. Its uuid matches the corresponding Session.session_uuid.

When to use

Use Room participants to add or remove individual Sessions and control their mute state and volume.

To add a participant, use the complete session_uuid from the Session creation response or session.created webhook. The participant list cannot supply this value before the Session joins the Room.

Methods

• List room participants
• Add a room participant
• Get room participant details
• Remove a room participant
• Mute a room participant
• Unmute a room participant
• Set room-participant volume

Use the room.participant.voice_activity_changed webhook to receive voice-activity transitions. These events are emitted only when the Room was created with voice_activity_events: true.

Choose the initial mute state

If a participant must join muted, send "muted": true. If you omit muted or set it to false, the participant joins unmuted.

Resource representation

{
  "muted": true,
  "uuid": "string"
}

Properties