Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-17164848.1 KB
room

Creates a room

post/room

Request body

maxPeersinteger nullable

Maximum amount of peers allowed into the room

peerDisconnectedTimeoutinteger nullable

Duration (in seconds) after which the peer will be removed if it is disconnected. If not provided, this feature is disabled.

peerlessPurgeTimeoutinteger nullable

Duration (in seconds) after which the room will be removed if no peers are connected. If not provided, this feature is disabled.

roomIdstring nullable

Custom id used for identifying room within Fishjam. Must be unique across all rooms. If not provided, random UUID is generated.

videoCodec'h264' | 'vp8' nullable

Enforces video codec for each peer in the room

webhookUrlstring nullable

URL where Fishjam notifications will be sent

Example request

{
  "maxPeers": 10,
  "peerDisconnectedTimeout": 60,
  "peerlessPurgeTimeout": 60,
  "webhookUrl": "https://backend.address.com/fishjam-notifications-endpoint"
}

Response

Room successfully created

Example response

{
  "data": {
    "fishjam_address": "fishjam1:5003",
    "room": {
      "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"
        }
      ]
    }
  }
}