List Streams by Room

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Video.

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequiredformat: "uuid"

Unique ID of the video room.

Response

The request has succeeded.

linksobject

Pagination links.

datalist of objects

List of streams.

1	{
2	"links": {
3	"self": "https://example.signalwire.com/api/video/rooms?page=2",
4	"first": "https://example.signalwire.com/api/video/rooms?page=1",
5	"next": "https://example.signalwire.com/api/video/rooms?page=3",
6	"prev": "https://example.signalwire.com/api/video/rooms?page=1"
7	},
8	"data": [
9	{
10	"id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
11	"url": "rtmp://broadcaster",
12	"stream_type": "rtmp",
13	"width": 1920,
14	"height": 1080,
15	"fps": 20,
16	"created_at": "2022-01-01T10:00:00Z",
17	"updated_at": "2022-01-01T11:00:00Z"
18	}
19	]
20	}

1	curl https://{your_space_name}.signalwire.com/api/video/rooms/id/streams \
2	-u "<project_id>:<api_token>"

Permissions

Authentication

Path parameters

Response

Errors