查询用户状态

更新时间不可用

查询指定频道中指定用户的在线状态。

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

该方法可查询指定频道中某个用户的状态。请求成功后,返回的参数包括用户是否在频道中、加入频道的时间和用户角色等。

鉴权

Basic Auth

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

路径参数

appidunknown
必填

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

uidunknown
必填

用户 ID。

注意:该参数暂不支持 String 型用户名(User Account),请确保使用整型用户 ID。

channelNameunknown
必填

频道名称。

响应

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

响应 Body

字段
successboolean

本次请求的状态:

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

用户状态数据。

请求示例

Example Request
curl --request GET \
  --url "https://api.sd-rtn.com/dev/v1/channel/user/property/:appid/:uid/:channelName" \
  --header 'Authorization: Basic <credentials>'

响应示例

{
  "success": true,
  "data": {
    "join": 1640330382,
    "uid": 2845863044,
    "in_channel": true,
    "platform": 7,
    "role": 2
  }
}