网易云信 IM 服务端支持更新用户名片相关信息。

功能描述

该接口可以更新指定云信账号的用户名片信息，包括性别、邮箱、生日等信息。

用户名片中包含的用户信息，在群组、聊天室等场景下，会暴露给群组、聊天室内的其他用户。其中 mobile，email，birthday，gender 等字段可能涉及隐私，属于非必填。如果您的业务下，这些信息为敏感信息，建议通过扩展字段 extension 填写相关信息并进行加密。

调用频率

单个应用默认最高调用频率请参考 频控说明。

请求

URL

PATCH https://open.yunxinapi.com/im/v2/users/:{account_id}

Header

请求 Header 的参数说明请参见 请求 Header。

路径参数

参数名称	类型	是否必选	描述
account_id	String	必选	需要更新用户名片的云信账号 ID。

请求体参数

参数名称	类型	是否必选	描述	默认值
name	String	可选	用户昵称。 长度上限 64 位字符。 需要通过反垃圾审核。	-
avatar	String	可选	用户头像的 URL 地址，例如 "https://netease/xxx.png" 。 长度上限 1024 位字符，可设置为空字符串。 需要通过反垃圾审核。	-
sign	String	可选	用户签名。 长度上限 256 位字符，可设置为空字符串。 需要通过反垃圾审核。	-
email	String	可选	用户邮箱地址。 需符合邮箱字符规则，例如 "zhangsan@xx.com"，可设置为空字符串。 长度上限 64 位字符。 需要通过反垃圾审核。	-
birthday	String	可选	用户生日，例如 "xxxx-xx-xx" 。 长度上限 16 位字符，可设置为空字符串。 需要通过反垃圾审核。	-
mobile	String	可选	用户手机号码。 长度上限 32 位字符，可设置为空字符串。 非中国大陆手机号码需要填写国家代码（如美国：+1-xxxxxxxxxx）或地区代码（如香港：+852-xxxxxxxx）。	-
gender	Integer	可选	用户性别，0-未知，1-男，2-女。	0
extension	String	可选	预留给开发者的扩展字段，建议封装成 JSON 格式，{key:value}。 长度上限 1024 位字符。 需要通过反垃圾审核。	-
- antispam_configuration	Object	可选	安全通相关配置项。	-
enabled	Boolean	可选	是否开启安全通，默认为 true，即默认使用安全通功能。如果需要设置单条消息不过安全通，则设置为 false。只有在云信控制台开通安全通业务的用户，该字段才有效，如未开启安全通业务，该字段无效。	true
- business_id_map	Array of objects	可选	安全通业务列表。	-
type	Integer	必选	检测类型。1：文本；2：图片。	-
business_id	String	必选	安全通业务 ID，可以指定当前群组信息过安全通某个检测策略。 默认情况下云信控制后台会生成默认业务，开通安全通后，客户端不需要配置业务 ID 就能默认走该策略，若需要自定义检测策略，请联系技术支持进行配置，配置好后传入对应的安全通业务 ID，表示当前群组信息过安全通的指定检测策略。	-

请求体示例

json{
    "name": "zhangsan",
    "avatar": "http://xxxx.xx/x.png",
    "sign": "Hello World",
    "email": "zhangsan@corp.xx.com",
    "birthday": "xxxx-xx-xx",
    "mobile": "13312345678",
    "gender": "2",
    "extension": "xxxx"
}

响应

Header

响应 Header 的参数说明请参见 响应 Header。

响应体参数

参数名称	类型	描述	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
account_id	String	云信账号 ID。	否
name	String	用户昵称。	否
avatar	String	用户头像的 URL 地址。	否
sign	String	用户签名。	否
email	String	用户邮箱地址。	否
birthday	String	用户生日。	否
mobile	String	用户手机号码。	否
gender	Integer	用户性别，0-未知，1-男，2-女。	否
extension	String	预留给开发者的扩展字段，建议封装成 JSON 格式。	否

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "account_id": "zhangsan",
        "name": "zhangsan",
        "avatar": "http://xxxx.xx/x.png",
        "sign": "Hello World",
        "email": "zhangsan@corp.xx.com",
        "birthday": "xxxx-xx-xx",
        "mobile": "13312345678",
        "gender": "2",
        "extension": "xxxx"
    }
}

错误码

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
102404	用户不存在	account not exist
103404	用户名片不存在	user profile not exist
103451	用户名片反垃圾审核未通过	user profile hit antispam
500	服务器内部错误	internal server error