DescribeChannelUser - 查询用户在频道内的信息_音视频通信(RTC)-阿里云帮助中心

本接口用于查询用户在频道内的信息。

接口说明

使用说明

本接口用于查询用户在频道内的信息。

QPS 限制

本接口的单用户 QPS 限制为 5 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	应用 ID，通过控制台创建和查询，仅支持传单个 ID。	eo85****
ChannelId	string	是	待查询的频道 ID，仅支持传单个 ID。	testid
UserId	string	是	用户 ID。	1811****

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	16A96B9A-F203-4EC5-8E43-CB92E68F4CF8
InChannel	boolean	用户当前是否在频道内。取值： true：在频道内。 false：不在频道内。
Sessions	object []	会话信息列表。
UserId	string	用户 ID。	1811****
SessionId	string	会话 ID。	xa744sxx8rtobgj****
Joined	long	用户进入频道的秒级时间戳（UTC 时间）。	1557909133
ChannelExist	boolean	频道是否存在。取值： true：存在。 false：不存在。

示例

正常返回示例

JSON格式

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CF8",
  "InChannel": true,
  "Sessions": [
    {
      "UserId": "1811****",
      "SessionId": "xa744sxx8rtobgj****",
      "Joined": 1557909133
    }
  ],
  "ChannelExist": true
}

错误码

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