UpdateFriendsAlias

POST

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

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

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

iOS	Android	macOS	Windows
friendInfoUpdated	onFriendInfoUpdated	friendInfoUpdated	onFriendInfoUpdated

Web	小程序	Flutter	React Native
friendInfoUpdated	friendInfoUpdated	onFriendInfoUpdated	friendInfoUpdated

uni-app \| uni-app x	HarmonyOS
friendInfoUpdated	friendInfoUpdated

说明

参数 FromUserId 和 UserId 对应的用户已在客户端调用 login 方法登录 ZIM 服务，或已调用服务端 API 完成注册。

说明

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

Request

Query Parameters

Action string必填

可选值: [UpdateFriendsAlias]

接口原型参数

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

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

FromUserId string必填

可选值: <= 32 characters

更新此用户对指定好友的备注。

UserIds object[]required

Possible values: <= 20

备注待更新的用户列表。单次最多修改 20 个用户。

Array[

UserId string必填

可选值: <= 32 characters

用户 ID。长度上限为 32 字节。

FriendAlias string

可选值: <= 256 characters

新的好友备注，长度不超过 256 字符。

]

Responses

application/json

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

Schema

Code integer

返回码。

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

说明

当您发起请求同时更新多个好友备注：

如果成功更新 1 个或更多好友备注，Code 都会返回 0。此时请参考 ErrorList 中的具体信息，确认操作结果。

如果全部好友备注更新失败，Code 会返回相关返回码，具体请参考全局返回码。

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

Message string

操作结果描述。

RequestId string

请求 ID。

ErrorList object[]

检查失败列表。

Code 为 0：
ErrorList 为空，全部好友备注修改成功。
ErrorList 不为空，表示部分好友备注修改失败，请参考 SubCode 处理。

Code 不为 0：
ErrorList 为空，表示参数错误、接口频率限制、系统错误。
ErrorList 不为空，表示全部好友备注都修改失败。

Array[

UserId string

好友备注修改失败的用户 ID。

SubCode number

具体失败返回码，完整返回码请参考 Code 说明或者全局返回码。

]

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

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

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

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