提交工单
咨询集成、功能及报价等问题
通过该接口,可为用户修改其好友的好友属性。
更新好友属性成功后,用户通过以下 ZIM SDK 的回调接口接收相关修改通知:
iOS | Android | macOS | Windows | Web |
---|---|---|---|---|
小程序 | Flutter | uni-app | React Native | |
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数。
参数 |
类型 |
是否必选 |
描述 |
FromUserId |
String |
是 |
更新此 UserID(已注册)对指定好友的属性设置。 |
UserId |
String |
是 |
好友属性待更新的用户。 |
Attributes |
Array Of Object |
是 |
新的好友属性。默认一次性最多批量更新 5 个属性。
Key 的总长度与 Value 的总长度上限为 1024 字节。如需上调,请联系 ZEGO 技术支持。建议不要将上限设置过大。 |
Key |
String |
是 |
好友属性的键。取值仅能为 k0、k1、k2、k3、k4。 |
Value |
String |
是 |
好友属性的值。 |
Action |
Number |
否 |
对属性的操作。0:设置属性。 |
FromUserId 和 UserId 仅支持数字,英文字符和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。
请求url
https://zim-api.zego.im/?Action=UpdateFriendAttributes
&<公共请求参数>
请求消息体
{
"FromUserId": "zego_user",
"UserId": "UserId",
"Attributes": [
{
"Key": "k0",
"Value": "Value1"
},
{
"Key": "k2",
"Value": "Value2"
}
],
"Action": 0
}
参数 | 类型 | 描述 |
---|---|---|
Code |
Number |
返回码。 当您发起请求同时更新多个好友属性:
|
Message |
String |
操作结果描述。 |
RequestId |
String |
请求 ID。 |
FailKey |
Array of Object |
好友属性修改失败信息列表。
|
Key |
String |
修改失败的好友属性键。 |
SubCode |
Number |
具体失败返回码。 |
{
"Code": 0,
"Message": "success",
"RequestId": "343649807833778782",
"FailKey": [
{
"key": "k0",
"SubCode": 660800032
}
]
}
以下仅列出了接口业务逻辑相关的返回码,完整返回码请参考 全局返回码。
返回码 | 描述 | 处理建议 |
---|---|---|
660000001 |
业务类通用错误。 |
请重试,或联系 ZEGO 技术支持。 |
660000002 |
输入参数错误。 |
请检查输入的参数。 |
660300005 |
调用接口的频率超出了 AppID 级别限制。 |
请稍后再试。 |
660800023 |
Attributes 的 Key 取值不属于 k0 ~ k4。 |
请修改 Key 的值。 |
660800024 |
|
请缩减相关字段的内容长度。 |
660800032 |
属性参数重复。 |
请修改重复参数。 |
联系我们
文档反馈