接口说明

使用说明

本接口用于查询频道内在线用户列表，不包含用户详细信息。

QPS 限制

本接口的单用户 QPS 限制为 1000 次/分钟。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	应用 ID，可通过控制台创建和查询，仅支持传单个 ID。	aec****
ChannelId	string	是	加入的频道，仅支持传单个 ID。	testId
Order	string	否	排序方式，取值： asc：递增。 desc（默认值）：递减。	asc
PageNum	integer	否	第几页，默认查询第 1 页。	1
PageSize	integer	否	每页显示用户数量，默认每页显示 10 条用户数据。	10

返回参数

名称	类型	描述	示例值
	object
TotalPage	integer	返回分页数。	1
RequestId	string	请求 ID。	6159ba01-6687-4fb2-a831-f0cd8d188648
Timestamp	integer	返回结果时间，使用 UNIX 时间戳表示，单位：秒。	1557909133
TotalNum	integer	返回结果数。	3
UserList	object
User	array	频道内用户 ID 列表。
	string	用户 ID 列表，多个用英文逗号（,）分隔。	27f9**,bb87,df82**

示例

正常返回示例

JSON格式

{
  "TotalPage": 1,
  "RequestId": "6159ba01-6687-4fb2-a831-f0cd8d188648",
  "Timestamp": 1557909133,
  "TotalNum": 3,
  "UserList": {
    "User": [
      "27f9****,bb87****,df82****"
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
500	Channel.InternalError	Channel operate internal error
500	Service.InternalError	service internal error
404	Channel.NotExist	Channel not existed	频道不存在
404	Service.NoSignaling	service no signaling

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。