Retrieve a specific active room

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.

If you need to get the list of all active sessions, you can use the list sessions API with the filter active as true.


curl --location --request GET 'https://api.100ms.live/v2/active-rooms/<room_id>' \
--header 'Authorization: Bearer <management_token>'

RESPONSE

Status: 200 OK


{
    "id": "631a0f990e6ffae22efa610c",
    "name": "5d971abb-8e51-4c86-9d35-8e619c3d8877",
    "customer_id": "627cdddff2e4e30487862ad1",
    "session": {
        "id": "633c22b420636a0cb361dea0",
        "created_at": "2022-10-04T12:10:28.939011796Z",
        "peers": [
            "c0bbae7e-fbc0-48c3-89aa-83f85427acbf",
            "161d2478-1535-49a0-b48b-326aaa26dcd0",
            "5e2c13af-dd3d-4a46-8265-f4648a0d68ef"
        ]
    }
}

Arguments

Name	Type	Description	Required
room_id — path param	`string`	Unique identifier of the active room you wish to fetch details for. Example: 631a0f990e6ffae22efa610c	Yes

Active room object Retrieve a specific peer

Have a suggestion? Recommend changes ->