Room Sessions

List room session members

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.

get/api/video/room_sessions/{id}/members

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/video/room_sessions/{id}/members
  • Auth
    HTTP basic

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of the Room Session.

Query parameters

page_numberinteger

Page number to return. Requires page_token for values greater than 0.

page_sizeinteger

Specify the number of results to return on a single page. The default page size is 50 and the maximum is 1000.

page_tokenstring

Token for cursor-based pagination. Required when page_number is greater than 0.

Response

The request has succeeded.

Example response

{
  "links": {
    "self": "https://example.signalwire.com/api/video/rooms?page=2",
    "first": "https://example.signalwire.com/api/video/rooms?page=1",
    "next": "https://example.signalwire.com/api/video/rooms?page=3",
    "prev": "https://example.signalwire.com/api/video/rooms?page=1"
  },
  "data": [
    {
      "name": "John Smith",
      "join_time": "2022-01-01T10:00:00Z",
      "leave_time": "2022-01-01T11:00:00Z",
      "duration": 120,
      "cost_in_dollars": 0.05
    }
  ]
}

Changes

No operation changes found yet. Some revisions have not been checked.