/api/channel/query
Use this interface to obtain detailed information of a channel.
Channel viewing permissions are required.
Prototype
| Protocol |
HTTP/HTTPS GET |
| URL |
ip[:port]/api/channel/query |
| Content-Type |
Response: Content-Type: application/json |
Request URL parameters
| Parameter |
Description |
| id |
Channel ID |
| output-start |
Optional parameter, used to set the starting index of the output in the channel. The default is 0 if not configured. |
| output-count |
Optional parameter, used to set the number of outputs returned in the channel. The default is 10 if not configured. |
| client-start |
Optional parameter, used to set the starting index of the client in the channel. The default is 0 if not configured. |
| client-count |
Optional parameter, used to set the number of clients returned in the channel. The default is 10 if not configured. |
Request Example
GET /api/channel/query?id=xxx&output-count=5&client-count=10 HTTP/1.1
Accept: application/json, text/plain, */*
Cookie: mwcloud-sid=OCXWUMGEYPGIAWWOETYXPNMVHDZIAZJP; mwcloud-uid=Admin;
Response Parameters
| Parameter |
Description |
| Content-Type |
Value: 'application/json; charset=UTF-8' |
Response Body
Response Example
{
"config": {
"enable": false,
"play-key": "PULL-B6C5FBB1-7476-48A4-B591-5B69E3FD0849",
"protocol": {
"ndihx": true,
"prefer": 1,
"rtmp": true,
"srt": true
},
"push-key": "PUSH-19D9753A-1D68-49E0-94BF-1965276A71C2"
},
"id": 100033,
"input": {
"addr": "",
"conn-state": 0,
"id": 1038,
"kbps": 0,
"name": "test1",
"protocol": 1,
"state": 1,
"type": 258
},
"name": "222",
"outputs": {
"list": [
{
"conn-state": 0,
"id": 11077,
"kbps": 0,
"living-time-s": 0,
"mode": "caller",
"name": "srt-233-mediahub-42",
"protocol": 2,
"report": {
"pkt-drop": 0,
"pkt-drop-total": 0,
"pkt-loss": 0.0
},
"state": 0,
"type": 514
},
{
"conn-state": 0,
"id": 11076,
"kbps": 0,
"living-time-s": 0,
"mode": "caller",
"name": "srt-233-mediahub-41",
"protocol": 2,
"report": {
"pkt-drop": 0,
"pkt-drop-total": 0,
"pkt-loss": 0.0
},
"state": 0,
"type": 514
}
],
"start": 0,
"total": 2
},
"result": 0,
"state": 1,
"url": {
"rtmp": {
"app": "live",
"play": "PULL-B6C5FBB1-7476-48A4-B591-5B69E3FD0849",
"port": 1935,
"push": "PUSH-19D9753A-1D68-49E0-94BF-1965276A71C2"
},
"srt": {
"passphrase": "1234567890",
"play": "PULL-B6C5FBB1-7476-48A4-B591-5B69E3FD0849",
"port": 80,
"push": "PUSH-19D9753A-1D68-49E0-94BF-1965276A71C2"
}
}
}