查询用户列表
更新时间不可用
查询指定频道内的用户列表。
GET
https://api.sd-rtn.com/dev/v1/channel/user/{appid}/{channelName}在不同频道场景下,该方法返回的列表具体如下:
- 通信场景下,频道内的用户列表。
- 直播场景下,频道内的主播列表和观众列表。
注意
- 同一频道内的用户必须使用相同的频道场景。否则,查询结果可能不准确。
- 该 API 和查询用户状态 API 均能用于同步在线频道状态信息。相比于查询用户状态 API,该 API 所需的调用频率低,查询效率高。因此,声网更推荐使用该 API 查询用户状态。
鉴权
appidunknown必填
项目的 App ID。可通过以下方式获取:
- 从声网控制台获取。
- 调用获取所有项目信息 API,并读取响应包体中
vendor_key字段的值。
channelNameunknown必填
频道名称。
响应
如果状态码为 200,则请求成功。
响应 Body
successboolean本次请求的状态:
true:请求成功false:预留
channel_existboolean指定频道是否存在:
true:存在false:不存在
注意:当 channel_exist 的值为 false 时,不会返回其它字段。
modenumber频道场景:
1:通信场景2:直播场景
totalnumber频道内的总人数。该字段仅在通信场景(mode 的值为 1 )下返回。
usersarray<integer>频道内所有用户的用户 ID。该字段仅在通信场景(mode 的值为 1)下返回。
broadcastersarray<integer>频道内所有主播的用户 ID。该字段仅在直播场景(mode 的值为 2)下返回。
audiencearray<integer>频道内观众的用户 ID。最多包含当前频道内前 10,000 名观众的用户 ID。该字段仅在直播场景(mode 的值为 2)且未填 hosts_only 参数时返回。
audience_totalnumber频道内的观众总人数。该字段仅在直播场景(mode 的值为 2)下且未填 hosts_only 参数时返回。
请求示例
curl --request GET \
--url "https://api.sd-rtn.com/dev/v1/channel/user/:appid/:channelName" \
--header 'Authorization: Basic <credentials>'响应示例
{
"success": true,
"data": {
"channel_exist": true,
"mode": 1,
"total": 1,
"users": [
906218805
]
}
}