v1

latestOpenAPI 3.0.0Apache 2.02026-07-17164848.1 KB
room

Shows information about the room

get/room/{room_id}

Path parameters

room_idstring required

Room ID

Response

Success

Example response

{
  "data": {
    "components": [
      {
        "id": "component-1",
        "type": "hls"
      }
    ],
    "config": {
      "maxPeers": 10,
      "peerDisconnectedTimeout": 60,
      "peerlessPurgeTimeout": 60,
      "webhookUrl": "https://backend.address.com/fishjam-notifications-endpoint"
    },
    "id": "room-1",
    "peers": [
      {
        "id": "peer-1",
        "metadata": {
          "name": "FishjamUser"
        },
        "status": "disconnected",
        "type": "webrtc"
      }
    ]
  }
}