更新好友备注

描述

通过该接口，可为一名用户批量修改至多 20 名好友的备注。如需上调（最多可为 50），请联系 ZEGO 技术支持。

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

iOS	Android	macOS	Windows	Web
friendInfoUpdated	onFriendInfoUpdated	friendInfoUpdated	onFriendInfoUpdated	friendInfoUpdated
小程序	Flutter	uni-app	React Native
friendInfoUpdated	onFriendInfoUpdated	friendInfoUpdated	friendInfoUpdated

接口原型

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

请求参数

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

参数	类型	是否必选	描述
FromUserId	String	是	更新此 UserID（已注册）对指定好友的备注。
UserIds	Array of Object	是	备注待更新的用户列表。单次最多修改 20 个用户。
└UserId	String	是	用户 ID。长度上限为 32 字节。
└FriendAlias	String	否	新的好友备注，长度不超过 256 字符。

请求示例

请求url

Untitled

https://zim-api.zego.im/?Action=UpdateFriendsAlias
&<公共请求参数>

Copied!

请求消息体

Untitled

{
    "FromUserId": "zego_user",
    "UserIds": [
        {
            "UserId": "user1",
            "FriendAlias": "FriendAlias1"
        },
        {
            "UserId": "user2",
            "FriendAlias": "FriendAlias2"
        }
    ]
}

Copied!

响应参数

参数	类型	描述
Code	Number	返回码。说明当您发起请求同时更新多个好友备注：如果成功更新 1 个或更多好友备注，Code 都会返回 0。此时请参考 ErrorList 中的具体信息，确认操作结果。如果全部好友备注更新失败，Code 会返回相关返回码，具体请参考全局返回码。
Message	String	操作结果描述。
RequestId	String	请求 ID。
ErrorList	Array of Object	失败信息列表。 Code 为 0： ErrorList 为空，全部好友备注修改成功。 ErrorList 不为空，表示部分好友备注修改失败，请参考 SubCode 处理。 Code 不为 0： ErrorList 为空，表示参数错误、接口频率限制、系统错误。 ErrorList 不为空，表示全部好友备注都修改失败。
└UserId	String	好友备注修改失败的用户 ID。
└SubCode	Number	具体失败返回码。

响应示例

Untitled

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782",
    "ErrorList": [
        {
            "UserId": "aaa",
            "SubCode": 660000012
        },
        {
            "UserId": "bbb",
            "SubCode": 660000013
        }
    ]
}

Copied!

返回码

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

返回码	描述	处理建议
660000001	业务类通用错误。	请重试，或联系 ZEGO 技术支持。
660000002	输入参数错误。	请检查输入的参数。
660300005	调用接口的频率超出了 AppID 级别限制。	请稍后再试。
660800019	单次批量操作超过上限。	减少单次批量操作数量。
660800021	`FriendAlias` 超过长度上限。	请缩减相关字段的内容长度。
660800034	此用户不是`FromUserId` 的好友。	请先添加此用户为好友。