Query streaming list
Updated
Queries current Media Gateway ingress streams.
https://api.agora.io/{region}/v1/projects/{appId}/rtls/ingress/online-streamsThis method queries the current list of ongoing Media Gateway streams, including the associated UID, channel name, stream status, bitrate, and audio and video metrics.
Note
If you specify a channel, the response only contains streams in that channel. Because Agora channel names support special characters, URL-encode the channel name before sending the request.
Path Parameters
Region for the streaming key or stream. Supported values are na for North America, eu for Europe, ap for Asia except mainland China, and cn for mainland China.
Important
Make sure that:
- The
regionvalue is the same as for the input source stream. - The domain names for setting the
regionparameter and streaming are the same. - The
regionvalue is in lowercase.
na | eu | ap | cnThe app ID provided by Agora to each developer. After creating a project in Agora Console, you can get an app ID. The app ID is a unique identifier for a project.
Query Parameters
The channel name. If specified, the response only contains streams in the specified channel. URL-encode the channel name before sending the request.
Header Parameters
The UUID (Universally Unique Identifier) of the request. After you pass in this field, the Agora server returns this field in the response header. It is recommended to assign X-Request-ID a value. If omitted, the Agora server automatically generates a UUID and returns it.
6d35d43f-f4c5-4b3a-9df4-8f0d7e1d5f0aResponse Body
application/json
application/json
application/json
Response schema
200application/jsonThe request succeeded and returned the streaming list.
401application/jsonThe request failed. A 401 (Unauthorized) response status code means the request is not authorized.
Response Headers
The UUID (Universally Unique Identifier) of the request. The value is in the X-Request-ID response header. If a request error occurs, print the value in the log to troubleshoot the problem.
200Example6d35d43f-f4c5-4b3a-9df4-8f0d7e1d5f0aRequest examples
curl --request GET \ --url https://api.agora.io/region/v1/projects/appId/rtls/ingress/online-streams \ --header 'Accept: application/json' \ --header 'Authorization: Basic 123' \ --header 'X-Request-ID: 'Response example
{ "status": "success", "data": [ { "sid": "string", "channel": "string", "uid": "string", "url": "string", "status": "Running", "beginAt": "2024-01-01 01:01:01.001", "bitrate": 0, "video": { "width": 0, "height": 0, "fps": 0 }, "audio": { "channels": 0, "sampleRate": 0 } } ]}{ "status": "error", "message": "Describes why the request failed."}{ "status": "error", "message": "Describes why the request failed."}