查询用户列表

更新时间不可用

查询指定频道内的用户列表。

GET
https://api.sd-rtn.com/dev/v1/channel/user/{appid}/{channelName}

在不同频道场景下,该方法返回的列表具体如下:

  • 通信场景下,频道内的用户列表。
  • 直播场景下,频道内的主播列表和观众列表。

注意

  • 同一频道内的用户必须使用相同的频道场景。否则,查询结果可能不准确。
  • 该 API 和查询用户状态 API 均能用于同步在线频道状态信息。相比于查询用户状态 API,该 API 所需的调用频率低,查询效率高。因此,声网更推荐使用该 API 查询用户状态。

鉴权

Basic Auth

声网频道管理 RESTful API 仅支持 HTTPS。发送请求时,你需要使用声网提供的客户 ID 和客户密钥生成 Base64 编码凭证,并填入请求头部的 Authorization 字段中。详见实现 HTTP 基本认证。

路径参数

appidunknown
必填

项目的 App ID。可通过以下方式获取:

channelNameunknown
必填

频道名称。

响应

如果状态码为 200,则请求成功。

响应 Body

字段
successboolean

本次请求的状态:

  • true:请求成功
  • false:预留

请求示例

Example Request
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
    ]
  }
}