ModifyUserInfo

POST

https://zim-api.zego.im/

通过该接口可以实现修改用户资料信息，包括用户昵称、头像等。

修改用户资料成功后，相关用户通过以下 ZIM SDK 的回调接口接收用户资料修改通知：

iOS	Android	macOS	Windows
userInfoUpdated	onUserInfoUpdated	userInfoUpdated	onUserInfoUpdated

Web	小程序	Flutter	Unity3D
userInfoUpdated	userInfoUpdated	onUserInfoUpdated	OnUserInfoUpdated

uni-app \| uni-app x	React Native	HarmonyOS
userInfoUpdated	userInfoUpdated	userInfoUpdated

说明

调用频率限制：20 次/秒。

Request

Query Parameters

Action string必填

可选值: [ModifyUserInfo]

接口原型参数

https://zim-api.zego.im/?Action=ModifyUserInfo

AppId uint32必填

💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台获取。

SignatureNonce string必填

💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考签名示例。

Timestamp int64必填

💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考签名示例，最多允许 10 分钟的误差。

SignatureVersion string必填

可选值: [2.0]

默认值: 2.0

💡公共参数。签名版本号。

Signature string必填

💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。

application/json

Body

required

UserInfo object[]required

Possible values: <= 100

资料待修改的用户列表。单次最多修改 100 个用户。

Array[

UserId string必填

可选值: <= 32 characters

修改此用户 ID（已在客户端调用 login 方法登录 ZIM 服务，或已调用服务端 API 完成注册）的资料。

UserName string

可选值: <= 256 characters

新用户名，长度不超过 256 字节。

UserAvatar string

可选值: <= 500 characters

新头像，长度不超过 500 字节。

Extra string

用户额外信息，长度默认 2 KB。如此上调，请联系 ZEGO 技术支持，最大可为 32 KB。

]

Responses

application/json

数据结构
按数据结构生成的示例

Schema

Code integer

返回码。

以下仅列出了接口业务逻辑相关的 Code 和 SubCode ，完整返回码请参考全局返回码。

Code / SubCode	描述	处理建议
660000002	参数错误。	请参考请求参数输入正确参数。
660300005	调用接口的频率超出了 AppID 级别限制。	请稍后再试。
660700012	用户未注册。	请先注册用户。
660700013	查询用户信息出错。	请联系 ZEGO 技术支持。
660700016	同步用户信息出错。	请联系 ZEGO 技术支持。
660700017	更新用户信息出错。	请联系 ZEGO 技术支持。

Message string

操作结果描述。

RequestId string

请求 ID。

ErrorList object[]

失败信息列表。

Code 为 0：
ErrorList 为空，全部用户资料修改成功。
ErrorList 不为空，表示部分用户资料修改失败，请参考 SubCode、SubMessage 处理。

Code 不为 0：
ErrorList 为空，表示参数错误、接口频率限制、系统错误。
ErrorList 不为空，表示全部用户资料都修改失败。

Array[

UserId string

资料修改失败的用户 ID。

SubCode number

用户资料修改失败的具体返回码，完整返回码请参考 Code 说明或者全局返回码。

SubMessage string

用户资料修改失败的原因说明。

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "ErrorList": [
    {
      "UserId": "aaa",
      "SubCode": 660000012,
      "SubMessage": "user length limit"
    },
    {
      "UserId": "bbb",
      "SubCode": 660000013,
      "SubMessage": "this is a demo"
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "ErrorList": [
    {
      "UserId": "aaa",
      "SubCode": 660000012,
      "SubMessage": "user length limit"
    },
    {
      "UserId": "bbb",
      "SubCode": 660000013,
      "SubMessage": "this is a demo"
    }
  ]
}