更新用户名片 - 即时通信

请求参数

Path 参数

account_id

string

必需

需要更新用户名片的云信账号 ID。

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

Body 参数application/json

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-女。

extension

string

预留给开发者的扩展字段

可选

建议封装成 JSON 格式，{key:value}。长度上限 1024 位字符。需要通过反垃圾审核。

antispam_business_id

string

安全通业务 ID

可选

可以指定当前信息过安全通某个检测策略。JSON 字符串，{"textbid":"","picbid":""} 。默认情况下，云信控制后台会生成默认业务，开通安全通后，无需配置业务 ID 就能默认走该策略，若需要自定义检测策略，请联系技术支持进行配置，配置好后传入对应的安全通业务 ID，表示当前信息过安全通的指定检测策略。

示例

{}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PATCH 'https://open.yunxinapi.com/im/v2/users/' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

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-女。

extension

string

预留给开发者的扩展字段

可选

建议封装成 JSON 格式，{key:value}。长度上限 1024 位字符。需要通过反垃圾审核。

antispam_business_id

string

安全通业务 ID

可选

可以指定当前信息过安全通某个检测策略。JSON 字符串，{"textbid":"","picbid":""} 。默认情况下，云信控制后台会生成默认业务，开通安全通后，无需配置业务 ID 就能默认走该策略，若需要自定义检测策略，请联系技术支持进行配置，配置好后传入对应的安全通业务 ID，表示当前信息过安全通的指定检测策略。

示例

{
  "code": 200,
  "msg": "success",
  "data": {
    "name": "apifoxtest200",
    "gender": 0,
    "account_id": "apifoxtest200"
  }
}

🟢200请求参数错误

🟢200服务器错误