REST ClientVideoRoom Sessions

listMembers

View as MarkdownOpen in Claude

List members for a particular video room session.

Path parameters

idstringRequiredformat: "uuid"
Unique ID of the Room Session.

Query parameters

page_numberintegerOptional>=0Defaults to 0
Page number to return. Requires `page_token` for values greater than 0.
page_sizeintegerOptional1-1000Defaults to 50
Specify the number of results to return on a single page. The default page size is `50` and the maximum is `1000`.
page_tokenstringOptional
Token for cursor-based pagination. Required when `page_number` is greater than 0.

Response

datalist of objectsRequired
List of room session members.

Response Example

Response
1{
2  "links": {
3    "self": "https://example.signalwire.com/api/video/rooms?page=2",
4    "first": "https://example.signalwire.com/api/video/rooms?page=1",
5    "next": "https://example.signalwire.com/api/video/rooms?page=3",
6    "prev": "https://example.signalwire.com/api/video/rooms?page=1"
7  },
8  "data": [
9    {
10      "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
11      "room_session_id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
12      "name": "John Smith",
13      "join_time": "2022-01-01T10:00:00Z",
14      "leave_time": "2022-01-01T11:00:00Z",
15      "duration": 120,
16      "cost_in_dollars": 0.05
17    }
18  ]
19}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com",
7});
8
9const members = await client.video.roomSessions.listMembers("session-id");
10for (const member of members.data ?? []) {
11  console.log(`${member.name}: ${member.id}`);
12}