提交工单
咨询集成、功能及报价等问题
根据用户 ID 分页拉取其好友列表,获取备注、好友关系建立时间等信息。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
FromUserId |
String |
是 |
查询此 UserID(已注册)的好友列表。 |
Limit |
Number |
是 |
单次拉取多少名好友的信息。取值范围为 [0, 100]。如果不填或数值为 0、大于 100,取值为 100。 |
Next |
Number |
是 |
分页拉取标志,第一次填 0 ,之后填上一次返回的 Next 值。当返回的 Next 为 0 时,代表好友列表获取完毕。 例如,FromUserId 有 250 个好友,调用本接口查询时:
|
https://zim-api.zego.im/?Action=QueryFriendList
&Limit=100&Next=2&FromUserId=zego
&<公共请求参数>
参数 | 类型 | 描述 |
---|---|---|
Code |
Number |
返回码。 |
Message |
String |
请求结果的说明信息。 |
RequestId |
String |
请求 ID。 |
TotalCount |
Number |
当前好友总数。 |
Next |
Number |
分页拉取标志,非 0 表示还有好友的信息未返回,需要将该字段设置到请求参数 Next 中拉取更多用户的信息;为 0 表示已经返回所有用户的信息。 |
FriendInfos |
Array of Object |
好友数据列表。 |
UserId |
String |
好友的用户 ID。 |
UserName |
String |
用户名称。 |
Avatar |
String |
用户头像地址。 |
Wording |
String |
建立好友关系时的附言。 |
FriendAlias |
String |
FromUserId 对此好友的备注。 |
CreateTime |
Number |
好友关系建立时间,单位为 ms。 |
Attributes |
Array Of Object |
好友属性。 |
Key |
String |
好友属性的键。 |
Value |
String |
好友属性的值。 |
{
"Code": 0,
"Message": "success",
"RequestId": "343649807833778782",
"TotalCount": 500,
"Next": 1,
"FriendInfos": [
{
"UserId": "UserA",
"UserName": "UserNameA",
"Avatar": "Avatar1",
"Wording": "Wording1",
"FriendAlias": "FriendAlias1",
"CreateTime": 1698310534000,
"Attributes": [
{
"Key": "k1",
"Value": "Value"
},
{
"Key": "k0",
"Value": "Value1"
}
]
},
{
"UserId": "UserB",
"UserName": "UserNameB",
"Avatar": "Avatar2",
"Wording": "Wording1",
"FriendAlias": "FriendAlias2",
"CreateTime": 1698310534000,
"Attributes": [
{
"Key": "k3",
"Value": "Value"
},
{
"Key": "k4",
"Value": "Value1"
}
]
}
]
}
以下仅列出了接口业务逻辑相关的返回码,完整返回码请参考 全局返回码。
返回码 | 说明 | 处理建议 |
---|---|---|
660000001 |
业务类通用错误。 |
请重试,或联系 ZEGO 技术支持。 |
660000002 |
参数错误。 |
请检查请求参数。 |
660300005 |
调用接口的频率超出了 AppID 级别限制。 |
请稍后再试。 |
联系我们
文档反馈