在网易云信智能体平台上新增一个用户的信息。

请求信息

请求 URI

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

请求头参数

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

请求体参数

参数名称	类型	是否必选	示例	说明
uid	String	是	Test1	用户 ID，需要调用方保证唯一。最大长度 32 字节，只允许字母、数字以及 "_@.-"
note	String	否	User1	用户备注
subAccountUid	String	否	sub_test1	子用户 ID，最大长度 32 字节，只允许字母、数字以及 "_@.-"
- userProperties	Object	否	-	用户属性信息
name	String	否	Kevin	用户名称
gender	String	否	MALE	用户性别。MALE 或者 FEMALE
birthYear	Integer	否	1990	出生年份

请求体示例

JSON{
    "uid": "Test1",
    "note": "User1",
    "userProperties": {
        "gender": "MALE",
        "name": "Kevin",
        "birthYear": 1990
    }
}

响应信息

响应参数

参数名称	类型	说明	是否必返回
code	Integer	状态码。200 表示成功	是
message	String	响应信息描述	是
requestId	String	请求唯一标识	是
data	Object	响应数据，新增用户成功时为 null	是
success	Boolean	操作是否成功	是

响应体示例

JSON{
    "code": 200,
    "message": "操作成功",
    "requestId": "ai2b6950e335e04c03bc047f44439bf7ac",
    "data": null,
    "success": true
}