查询用户状态
更新时间不可用
查询指定频道中指定用户的在线状态。
GET
https://api.sd-rtn.com/dev/v1/channel/user/property/{appid}/{uid}/{channelName}该方法可查询指定频道中某个用户的状态。请求成功后,返回的参数包括用户是否在频道中、加入频道的时间和用户角色等。
鉴权
appidunknown必填
项目的 App ID。可通过以下方式获取:
- 从声网控制台获取。
- 调用获取所有项目信息 API,并读取响应包体中
vendor_key字段的值。
uidunknown必填
用户 ID。
注意:该参数暂不支持 String 型用户名(User Account),请确保使用整型用户 ID。
channelNameunknown必填
频道名称。
响应
如果状态码为 200,则请求成功。
响应 Body
successboolean本次请求的状态:
true:请求成功false:预留
用户状态数据。
in_channelboolean用户当前是否在频道内:
true:是false:否
注意:
当 in_channel 的值为 false 时不会返回其他字段。
joinnumber用户加入频道的 Unix 时间戳,单位为秒。
uidnumber用户 ID。
rolenumber用户在频道内的角色:
0:未知1:通信场景下的用户2:直播场景下的主播3:直播场景下的观众
platformnumber用户设备所属平台,常见的返回值如下:
1:Android2:iOS5:Windows6:Linux7:Web8:macOS0:其它平台
请求示例
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
}
}