查询在网易云信智能体平台上的用户列表。

• 支持分页查询智能体平台用户列表
• 返回用户基本信息和自定义属性
• 可根据页码和每页条数进行灵活查询

请求信息

请求 URI

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

请求头参数

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

请求查询参数

参数名称	类型	是否必选	示例	说明
page	Integer	否	1	页码，从 1 开始，默认为 1
limit	Integer	否	20	每页条数，取值范围为 1~100，默认为 20

请求示例

GET https://rtc-agent.yunxinapi.com/v1/ai_users?page=1&limit=20

响应信息

响应参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功	是
message	String	提示信息。请求失败时返回错误信息，请求成功时返回 操作成功	是
requestId	String	请求唯一标识符	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象	是
total	Long	用户总数量	是
- users	Array	用户列表	是
uid	String	用户唯一标识符	是
note	String	用户备注信息	否
status	Integer	用户状态，1 表示正常，0 表示禁用	是
- userProperties	Object	用户自定义属性对象	否
gender	String	性别，MALE 表示男性，FEMALE 表示女性	否
birthYear	Integer	出生年份	否
name	String	用户昵称	否
age	Integer	用户年龄	否
success	Boolean	请求是否成功	是

响应体示例

JSON{
    "code": 200,
    "message": "操作成功",
    "requestId": "aib91c3664c4214156ac44cfbb2f0c5525",
    "data": {
        "total": 7,
        "users": [
            {
                "uid": "Test4",
                "note": null,
                "status": 1,
                "userProperties": {
                    "gender": "MALE",
                    "birthYear": 1991,
                    "name": "TestName"
                },
                "age": 34
            },
            {
                "uid": "Test3",
                "note": null,
                "status": 1,
                "userProperties": {
                    "gender": "MALE"
                },
                "age": null
            }
        ]
    },
    "success": true
}