Sign in
Streams

List room streams

Returns the outbound RTMP or RTMPS streams created for one Video Room. Use it to discover the stream IDs associated with a known room before retrieving, changing, or stopping a stream. For live voice-call audio sent over WebSocket, use the Compatibility API's Create stream operation instead.

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/rooms/{id}/streams

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of the video room.

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": [
    {
      "url": "rtmp://broadcaster",
      "stream_type": "rtmp",
      "width": 1920,
      "height": 1080,
      "fps": 20,
      "created_at": "2022-01-01T10:00:00Z",
      "updated_at": "2022-01-01T11:00:00Z"
    }
  ]
}

Changes

No changes found, but 3 of the 137 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.