List room session members

GET

https://{your_space_name}.signalwire.com/api/video/room_sessions/:id/members

GET

/api/video/room_sessions/:id/members

$ curl https://{your_space_name}.signalwire.com/api/video/room_sessions/id/members \
>      -u "<project_id>:<api_token>"

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 }

Lists the participants associated with one Room Session for attendance and session auditing. Participant controls for a live room belong in the client SDK rather than this read-only history endpoint.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Video.

Learn more about API scopes.

Lists the participants associated with one Room Session for attendance and session auditing. Participant controls for a live room belong in the client SDK rather than this read-only history endpoint. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Video_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

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

The request has succeeded.

linksobject

Pagination links.

datalist of objects

List of room session members.

Errors

400

Bad Request Error

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error