List external streams

Use this request to list and filter through external stream objects of a workspace. The response is paginated.

This list can be filtered by room_id, session_id or status to find the relevant external stream object.

curl --location --request GET '' \ --header 'Authorization: Bearer <management_token>'
Status: 200 OK
{ "limit": 10, "data": [ { "id": "<job_id>", "room_id": "<room_id>", "session_id": "<session_id>", "status": "<status>", "destination": "<destination_name>", "rtmp_urls": ["<rtmp_url_1>", "<rtmp_url_2>"], "meeting_url": "<meeting_url>", "recording": true, "resolution": { "width": 1280, "height": 720 }, "created_at": "2023-03-02T07:44:27.010516042Z", "started_at": "2023-03-02T07:44:27.010516042Z", "stopped_at": "2023-03-02T07:44:27.010516042Z", "updated_at": "2023-03-02T07:44:27.010516042Z", "started_by": "<peer_id>", "stopped_by": "<peer_id>", "recording_assets": [{ "id": "<asset-id>", "thumbnails": [], "duration": 42, "path": "<recording_path>", "status": "<status>", "created_at": "2023-03-02T07:44:27.010516042Z", "type": "<asset-type>", "size": 42, "metadata": { "resolution": { "width": 1280, "height": 720 } } }] } ], "last": "<stream-id-of-last>" }

Query params

room_idFilter external streams for a particular room with its identifierNo
session_idFilter external streams for a particular session with its identifierNo
statusCan be one of starting, running, stopping, post_processing, completed, failedNo
startSets the starting point for paginationNo
limitSets the number of objects to returned in the responseNo

Have a suggestion? Recommend changes ->

Run in postman

Was this helpful?