输入关键词搜索

查询用户信息

更新时间: 2025/09/11 14:33:44

查询指定用户的详细信息,包括用户属性和子用户信息,返回用户的完整配置信息。

请求信息

请求 URI

GET https://rtc-agent.yunxinapi.com/v1/ai_users/{uid}

请求头参数

请求 Header 的参数说明请参考 请求结构

请求路径参数

参数名称 类型 是否必选 示例 说明
uid String test_user_1 用户唯一标识,最大长度32字节

请求查询参数

参数名称 类型 是否必选 示例 说明
subAccountUid String sub_user_01 子用户ID,最大长度32字节,只允许字母、数字以及"_@.-"。

响应信息

响应参数

参数名称 类型 说明 是否必返回
code Integer 状态码,200表示请求成功
message String 提示信息,请求失败时返回错误信息,请求成功时返回"success"
- data Object 返回的JSON数据对象,请求失败则返回空对象
uid String 用户唯一标识
note String 用户备注信息
- userProperties Object 用户属性对象
gender String 性别,如"MALE"、"FEMALE"
birthYear Integer 出生年份
name String 用户姓名
- subAccounts Array 子用户数组
uid String 子用户唯一标识
note String 子用户备注信息
- userProperties Object 子用户属性对象
gender String 子用户性别
birthYear Integer 子用户出生年份
name String 子用户姓名

响应体示例

JSON{
  "code": 200,
  "message": "success",
  "data": {
    "uid": "test_user_1",
    "note": "主用户账户",
    "userProperties": {
      "gender": "MALE",
      "birthYear": 1991,
      "name": "TestName"
    },
    "subAccounts": [
      {
        "uid": "sub_user_01",
        "note": "子用户账户1",
        "userProperties": {
          "gender": "FEMALE",
          "birthYear": 1995,
          "name": "SubTestName"
        }
      }
    ]
  }
}

错误码

完整列表请参考 错误码

此文档是否对你有帮助?
有帮助
去反馈
  • 请求信息
  • 请求 URI
  • 请求头参数
  • 请求路径参数
  • 请求查询参数
  • 响应信息
  • 响应参数
  • 响应体示例
  • 错误码