有奖捉虫:云通信与企业服务文档专题,速来> HOT

功能说明

分页拉取全量好友数据。
不支持资料数据的拉取。
不需要指定请求拉取的字段,默认返回全量的标配好友数据和自定义好友数据。

接口调用说明

请求 URL 示例

https://xxxxxx/v4/sns/friend_get?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参见 REST API 简介
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名:
中国:console.tim.qq.com
新加坡:adminapisgp.im.qcloud.com
首尔: adminapikr.im.qcloud.com
法兰克福:adminapiger.im.qcloud.com
孟买:adminapiind.im.qcloud.com
硅谷:adminapiusa.im.qcloud.com
雅加达:adminapiidn.im.qcloud.com
v4/sns/friend_get
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号,更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名,具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数,取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

{
"From_Account": "id",
"StartIndex": 0,
"StandardSequence": 0
}

请求包字段说明

字段
类型
属性
说明
From_Account
String
必填
指定要拉取好友数据的用户的 UserID
StartIndex
Integer
必填
分页的起始位置
StandardSequence
Integer
选填
上次拉好友数据时返回的 StandardSequence,如果 StandardSequence 字段的值与后台一致,后台不会返回标配好友数据

应答包体示例

{
"UserDataItem": [
{
"To_Account": "id1",
"ValueItem": [
{
"Tag": "Tag_SNS_IM_AddSource",
"Value": "AddSource_Type_Android"
},
{
"Tag": "Tag_SNS_IM_Remark",
"Value": "Remark1"
},
{
"Tag": "Tag_SNS_IM_Group",
"Value":["Group1","Group2"]
},
{
"Tag": "Tag_SNS_IM_AddTime",
"Value": 1563867420
},
{
"Tag": "Tag_SNS_Custom_Test",
"Value": "CustomData1"
}
]
},
{
"To_Account": "id2",
"ValueItem": [
{
"Tag": "Tag_SNS_IM_AddSource",
"Value": "AddSource_Type_IOS"
},
{
"Tag": "Tag_SNS_IM_Group",
"Value":["Group1"]
},
{
"Tag": "Tag_SNS_IM_AddTime",
"Value": 1563867425
}
]
}
],
"StandardSequence": 88,
"FriendNum": 20,
"CompleteFlag": 1,
"NextStartIndex": 0,
"ActionStatus": "OK",
"ErrorCode": 0,
"ErrorInfo": "",
"ErrorDisplay": ""
}

应答包字段说明

字段
类型
说明
UserDataItem
Array
好友对象数组,每一个好友对象都包含一个 To_Account 字段和一个 ValueItem 数组
To_Account
String
好友的 UserID
ValueItem
Array
保存好友数据的数组,数组每一个元素都包含一个 Tag 字段和一个 Value 字段
Tag
String
好友字段的名称
Value
String/Integer/Array
好友字段的值,详情可参见 关系链字段
StandardSequence
Integer
标配好友数据的 Sequence,客户端可以保存该 Sequence,下次请求时通过请求的 StandardSequence 字段返回给后台
FriendNum
Integer
好友总数
CompleteFlag
Integer
分页的结束标识,非0值表示已完成全量拉取
NextStartIndex
Integer
分页接口下一页的起始位置
ActionStatus
String
请求处理的结果:
OK:表示处理成功
FAIL:表示失败
ErrorCode
Integer
错误码:
0:表示成功
非0:表示失败,非0取值的详细描述请参见 错误码说明
ErrorInfo
String
详细错误信息
ErrorDisplay
String
详细的客户端展示信息

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 ErrorCode 以及 ErrorInfo 来表示的。 公共错误码(60000到79999)请参见 错误码。 本 API 私有错误码如下:
错误码
描述
30001
请求参数错误,请根据错误描述检查请求参数
30003
请求的用户账号不存在
30004
请求需要 App 管理员权限
30006
服务器内部错误,请重试
30007
网络超时,请稍后重试

接口调试工具

通过 REST API 在线调试工具 调试本接口。

更多文档

添加好友(v4/sns/friend_add
导入好友(v4/sns/friend_import
更新好友(v4/sns/friend_update
删除好友(v4/sns/friend_delete
删除所有好友(v4/sns/friend_delete_all
校验好友(v4/sns/friend_check
拉取指定好友(v4/sns/friend_get_list