logo
当前页

获取某个用户属性


描述

拉取教室内某个用户的属性信息,包括用户角色、用户 uid、用户昵称、用户摄像头和麦克风状态、用户权限等。

调用频率限制:10 次/秒

接口原型

  • 请求方法:POST
  • 请求地址:/edu_room/get_user_info
  • 传输协议:application/json

请求参数

参数类型是否必选示例描述
room_idString"123456"教室房间 ID,只能包含数字,最长 9 个字符。
uidInt64171171717用户 ID。
target_uidInt64171171717目标用户 ID,当与用户 ID 一致时,表示拉取本人的数据。

请求示例

{
  "uid":171171717,
  "room_id":"123456",
  "target_uid":171171717
}

响应参数

参数类型示例描述
uidInt64171171717用户 ID。
nick_nameString"Shawn"用户昵称。
roleInt321用户角色,取值如下:
  • 1:老师
  • 2:学生
cameraInt321用户摄像头状态,取值如下:
  • 1:关闭
  • 2:打开
micInt321用户麦克风状态,取值如下:
  • 1:关闭
  • 2:打开
can_shareInt322用户共享权限状态,取值如下:
  • 1:关闭
  • 2:打开
login_timeInt641600929248051用户登录教室时间,为 Unix 时间戳,单位:毫秒。
join_live_timeInt641600929258537用户连麦时间,为 Unix 时间戳,单位:毫秒。

响应示例

{
  "ret": {
    "code": 0,
    "message": "succeed"
  },
  "data": {
    "uid": 171171717,
    "nick_name": "Shawn",
    "role": 1,
    "login_time": 1600929248051,
    "join_live_time": 1600929258537,
    "camera": 2,
    "mic": 2,
    "can_share": 2
  }
}

返回码

返回码描述
10004目标用户不在教室。

Previous

获取连麦成员列表

Next

修改某个用户属性