文档中心
IM 即时通讯
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录
中文站 English
  • 文档中心
  • 即时通讯
  • 服务端 API
  • 用户相关
  • 修改用户资料

修改用户资料

更新时间:2024-03-18 15:33

描述

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

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

iOS Android macOS Windows Web
userInfoUpdated
onUserInfoUpdated
userInfoUpdated
onUserInfoUpdated
userInfoUpdated
小程序 Flutter Unity3D uni-app React Native
userInfoUpdated
onUserInfoUpdated
OnUserInfoUpdated
userInfoUpdated
userInfoUpdated

接口原型

  • 请求方法:POST
  • 请求地址: https://zim-api.zego.im/?Action=ModifyUserInfo
  • 传输协议:HTTPS
  • 调用频率限制:20 次/秒

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数。

参数
类型
是否必选
描述
UserInfo
Array of Object
是
资料待修改的用户列表。单次最多修改 100 个用户。
UserId
String
是
修改此用户 ID 的资料。
UserName
String
否
新用户名,长度不超过 256 字节。
UserAvatar
String
否
新头像,长度不超过 500 字节。
Extra
String
否
用户额外信息,长度默认 2 KB。如此上调,请联系 ZEGO 技术支持,最大可为 32 KB。

请求示例

  • 请求url

    https://zim-api.zego.im/?Action=ModifyUserInfo&<公共请求参数>
  • 请求消息体

    {
        "UserInfo": [
            {
                "UserId": "aaa",
                "UserName": "userNamea",
                "UserAvatar": "http",
                "Extra": "extra info"
            },
            {
                "UserId": "bbb",
                "UserName": "userNameb",
                "UserAvatar": "http"
            }
        ]
    }

响应参数

参数 类型 描述
Code
Number
返回码。
Message
String
操作结果描述。
RequestId
String
请求 ID。
ErrorList
Array of Object
失败信息列表。

  • Code 为 0:
    • ErrorList 为空,全部用户资料修改成功。
    • ErrorList 不为空,表示部分用户资料修改失败,请参考 SubCode、SubMessage 处理。
  • Code 不为 0:
    • ErrorList 为空,表示参数错误、接口频率限制、系统错误。
    • ErrorList 不为空,表示全部用户资料都修改失败。
UserId
String
资料修改失败的用户 ID。
SubCode
Number
用户资料修改失败的具体返回码。
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"
        }
    ]
}

返回码

返回码 描述 处理建议
660000002
参数错误。
请参考 请求参数 输入正确参数。
660300005
调用接口的频率超出了 AppID 级别限制。
请稍后再试。
660700012
用户未注册。
请先注册用户。
660700013
查询用户信息出错。
请联系 ZEGO 技术支持。
660700016
同步用户信息出错。
请联系 ZEGO 技术支持。
660700017
更新用户信息出错。
请联系 ZEGO 技术支持。
本篇目录
  • 免费试用
  • 提交工单
    咨询集成、功能及报价等问题
    电话咨询
    400 1006 604
    咨询客服
    微信扫码,24h在线

    联系我们

  • 文档反馈