listEvents | SignalWire

List events 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

linksobjectRequired

Pagination links.

datalist of objectsRequired

List of room session events.

Response 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": [
    {
      "id": "e44f56a8-7c69-6153-b45c-ab3456789012",
      "project_id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
      "room_id": "b2c3d4e5-6f70-8901-bcde-f12345678901",
      "room_session_id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
      "level": "info",
      "name": "room.started",
      "payload": {},
      "created_at": "2022-01-01T10:00:00Z",
      "room_recording_id": "d33e35f7-6b58-5042-a34b-ef2345678901",
      "room_participant_id": "e44f68a9-7c69-6153-b56d-ef3456789012"
    }
  ]
}

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com",
});
const events = await client.video.roomSessions.listEvents("session-id");
for (const event of events.data ?? []) {
  console.log(`${event.type}: ${event.id}`);
}