Active room APIs

Number of APIs: 7

1. Get Active Room Details

GET {{HOST}}/v2/active-rooms/<room_id>

Retrieves the details of a specific active room. 100ms allows you to retrieve details of an active room with their ID.

• You can use this API to check if a room is currently active or not.
• You can also use this in conjunction with retrieve peer API and perform actions such as updating peers, sending messages, and removing peers based on your use case requirements.

---

2. Get Peer Details

GET {{HOST}}/v2/active-rooms/:room_id/peers/:peer_id

Retrieves the details of a specific peer in an active room. You can use the peer_id to retrieve the details of the peer. Use retrieve active room state API to get the list of connected peers in an active room.

Note: You can leverage this API to retrieve the details of connected peers in an active room only. To retrieve details of the peers that left the session already, use the Retrieve a specific session API

Why would you use this API?

• To check if a specific peer has enabled/disabled their audio/video/screen-share at a given time in an active room.
• To check if a specific peer is on-stage and backstage at a particular time.
• You can also use this API to store peer metadata in your database and retrieve it for an abruptly disconnected peer once they join the session again. For example, to enable the user to resume playing the multiplayer game.

---

3. List Peers

GET {{HOST}}/v2/active-rooms/:room_id/peers

---

4. Update Peer

POST {{HOST}}/v2/active-rooms/:room_id/peers/:peer_id

You can use this API to update the details of a connected peer, such as name, role, and metadata (custom/additional information to build real-time interactivity scenarios).

Arguments

Name	Type	Description	Required
room_id — path param	string	Unique identifier of the room where the peer is active. Example: 627cda81ab4f3b56a077dc33	Yes
peer_id — path param	string	Unique identifier of the peer/participant for which you wish to update details. Example: 1038fa72-9345-4651-beab-436f9242ebf4	Yes
name — body param	string	The name of the peer used in the active session.	No
role — body param	string	You can use this to update the role type of the peer. For example, to take the peer to a breakout room.	No
metadata — body param	object	You can use a stringified JSON to update various custom/additional information to a peer such as businessuserid, raisehand/lowerhand info, and more	No

Why would you use this API?

• You can use these APIs to update various properties of the connected peer, such as avatar, BRB status, hand-raise status, etc.
• Custom Avatar:
  • A user updates their profile information on your app/ongoing session; the data is stored in your data store.
  • Use Update peer API and pass the profile picture data from your data store to your client app to display it as the respective connected peer's avatar (based on user_id mapping).

---

5. Send Message

POST {{HOST}}/v2/active-rooms/<room_id>/send-message

You can use this API to send messages to a single peer, a set of peers (a particular role), or all connected peers in the active room. This API supports arguments such as peer_id and role to implement this.

1. If peer_id is specified -- message will be sent only to the specified connected peer.
2. If the role is specified -- message will be sent to all the connected peers assigned with that particular role.
3. If both peer_id and role are specified -- preference will be given to the peer_id and the message will be sent only to the specified connected peer.
4. If both peer_id and role are not specified -- message(broadcast) will be sent to all the connected peers.

Arguments

Name	Type	Description FAQs More Claim this page Report this page ENDPOINTS