logo
即时通讯
机器人
ZIM Audio
当前页

更新好友属性

POST

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

通过该接口,可为用户修改其好友的好友属性。

更新好友属性成功后,用户通过以下 ZIM SDK 的回调接口接收相关修改通知:

iOSAndroidmacOSWindows
friendInfoUpdatedonFriendInfoUpdatedfriendInfoUpdatedonFriendInfoUpdated
Web小程序FlutterReact Native
friendInfoUpdatedfriendInfoUpdatedonFriendInfoUpdatedfriendInfoUpdated
uni-app | uni-app xHarmonyOS
friendInfoUpdatedfriendInfoUpdated
说明

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

说明
参数 FromUserId 和 UserId 仅支持数字,英文字符和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'
说明
调用频率限制:20 次/秒。

Request

Query Parameters

    Action string必填

    可选值: [UpdateFriendAttributes]

    接口原型参数

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

    AppId uint32必填

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

    SignatureNonce string必填

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

    Timestamp int64必填

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

    SignatureVersion string必填

    可选值: [2.0]

    默认值: 2.0

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

    Signature string必填

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

Body

required
    FromUserId string必填

    可选值: <= 32 characters

    更新此 UserID 对指定好友的属性设置。

    UserId string必填

    可选值: <= 32 characters

    好友属性待更新的用户。

    Attributes object[]required
    Possible values: <= 5
    新的好友属性。默认一次性最多批量更新 5 个属性。
    说明
    Key 的总长度与 Value 的总长度上限为 1024 字节。如需上调,请联系 ZEGO 技术支持。建议不要将上限设置过大。
  • Array[
  • Key string必填

    可选值: [k0, k1, k2, k3, k4]

    好友属性的键。取值仅能为 k0、k1、k2、k3、k4。

    Value string必填

    好友属性的值。

  • ]
  • Action number

    默认值: 0

    对属性的操作。0:设置属性。

Responses

OK
Schema
    Code integer

    返回码。

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

    说明

    当您发起请求同时更新多个好友属性:

    • 如果成功更新 1 个或更多属性,Code 都会返回 0。此时请参考 FailKey 中的具体信息,确认操作结果。
    • 如果全部好友属性更新失败,Code 会返回相关返回码,具体请参考 全局返回码
    Code / SubCode描述处理建议
    660000001业务类通用错误。请重试,或联系 ZEGO 技术支持。
    660000002输入参数错误。请检查输入的参数。
    660300005调用接口的频率超出了 AppID 级别限制。请稍后再试。
    660800023Attributes 的 Key 取值不属于 k0 ~ k4。请修改 Key 的值。
    660800024如果是 Code:此接口传递的 Attributes 的所有 Key 和 Value 总长度超过上限。
    如果是 SubCode:加上此 Key 和 Value 后,目标用户的好友属性总长度超过上限。
    请缩减相关字段的内容长度。
    660800032属性参数重复。请修改重复参数。
    Message string

    操作结果描述。

    RequestId string

    请求 ID。

    FailKey object[]
    好友属性修改失败信息列表。
    • Code 为 0:
    • FailKey 为空,全部好友属性更新成功。
    • FailKey 不为空,表示部分好友属性更新失败,请参考 SubCode 处理。
    • Code 不为 0:
    • FailKey 为空,表示参数错误、接口频率限制、系统错误。
    • FailKey 不为空,表示全部好友属性都更新失败。
  • Array[
  • Key string

    修改失败的好友属性键。

    SubCode number

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

  • ]

Previous

更新好友备注

Next

批量拉黑用户

当前页

返回到顶部