調用DescribeChannelUsers查詢頻道內在線用戶列表的詳細信息。
使用說明
本接口用于查詢頻道內在線用戶列表的詳細信息。例如：您可以查詢通信模式和直播模式下的用戶總數。
QPS限制
本接口的單用戶QPS限制為100次/秒。超過限制，API調用會被限流，這可能會影響您的業務，請合理調用。更多信息，請參見QPS限制。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
| 名稱 | 類型 | 是否必選 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeChannelUsers |
系統規定參數。取值：DescribeChannelUsers。 |
| AppId | String | 是 | a2hz**** |
應用ID，通過控制臺創建和查詢，僅支持傳單個ID。 |
| ChannelId | String | 是 | testId |
要查詢的頻道ID，僅支持傳單個ID。 |
返回數據
| 名稱 | 類型 | 示例值 | 描述 |
|---|---|---|---|
| CommTotalNum | Integer | 100 |
通信模式下頻道內的用戶總數，如果頻道為非通信模式，該參數為0。 |
| RequestId | String | 6159ba01-6687-4fb2-a831-f0cd8d188648 |
請求ID。 |
| IsChannelExist | Boolean | true |
頻道是否存在，取值：
|
| LiveUserNum | Integer | 0 |
直播模式下頻道內的觀眾總數，如果頻道為非直播模式，該參數為0。 |
| Timestamp | Integer | 1557909133 |
當前時刻的時間戳（UTC時間）。 |
| ChannelProfile | Integer | 1 |
頻道模式，取值：
|
| InteractiveUserNum | Integer | 0 |
直播模式下頻道內的互動者用戶總數，如果頻道為非直播模式，該參數為0。 |
| UserList | Array of String | [] |
通信模式下頻道的用戶列表，如果頻道為非通信模式，該參數為空。 |
| InteractiveUserList | Array of String | ["4455****", "3267****", "efbc****"] |
直播模式下頻道內的互動用戶列表，如果頻道為非直播模式，該參數為空。 |
| LiveUserList | Array of String | ["4455****", "3267****", "efbc****"] |
直播模式下頻道內的觀眾列表，只返回前1000人，如果頻道為非直播模式，該參數為空。 |
示例
請求示例
https://rtc.aliyuncs.com/?Action=DescribeChannelUsers
&AppId=a2hz****
&ChannelId=testId
&<公共請求參數>正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeChannelUsersResponse>
<RequestId>6159ba01-6687-4fb2-a831-f0cd8d188648</RequestId>
<TimeStamp>1557909133</TimeStamp>
<IsChannelExist>true</IsChannelExist>
<ChannelProfile>1</ChannelProfile>
<CommTotalNum>100</CommTotalNum>
<InteractiveUserNum>0</InteractiveUserNum>
<LiveUserNum>0</LiveUserNum>
<UserList>4455****</UserList>
<UserList>3267****</UserList>
<UserList>efbc****</UserList>
</DescribeChannelUsersResponse>JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "6159ba01-6687-4fb2-a831-f0cd8d188648",
"TimeStamp" : 1557909133,
"IsChannelExist" : true,
"ChannelProfile" : 1,
"CommTotalNum" : 100,
"InteractiveUserNum" : 0,
"LiveUserNum" : 0,
"UserList" : [ "4455****", "3267****", "efbc****" ],
"InteractiveUserList" : [ ],
"LiveUserList" : [ ]
}