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

功能说明

拉取分组,支持指定分组以及拉取分组下的好友列表。

接口调用说明

请求 URL示例

https://xxxxxx/v4/sns/group_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/group_get
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号,更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名,具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数,取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

基础形式
{
"From_Account":"id"
}
完整形式
{
"From_Account": "id",
"NeedFriend": "Need_Friend_Type_Yes",
"GroupName": [
"group1"
]
}

请求包字段说明

字段
类型
属性
说明
From_Account
String
必填
指定要拉取分组的用户的 UserID
NeedFriend
String
选填
是否需要拉取分组下的 User 列表, Need_Friend_Type_Yes: 需要拉取, 不填时默认不拉取, 只有 GroupName 为空时有效
GroupName
Array
选填
要拉取的分组名称

应答包体示例

基础形式
{
"ResultItem": [
{
"GroupName": "group1",
"FriendNumber": 1
},
{
"GroupName": "group2",
"FriendNumber": 2
},
{
"GroupName": "group3",
"FriendNumber": 3
}
],
"CurrentSequence": 2,
"ActionStatus": "OK",
"ErrorCode": 0,
"ErrorInfo": "",
"ErrorDisplay": ""
}
完整形式
{
"ResultItem": [
{
"GroupName": "group1",
"FriendNumber": 1,
"To_Account": ["friend1"]
}
],
"CurrentSequence": 2,
"ActionStatus": "OK",
"ErrorCode": 0,
"ErrorInfo": "",
"ErrorDisplay": ""
}

应答包字段说明

字段
类型
说明
ResultItem
Array
拉取分组的结果对象数组
GroupName
String
分组名
FriendNumber
Integer
该分组下的好友数量
To_Account
Array
该分组下的好友的 UserID
CurrentSequence
Integer
返回最新的分组 Sequence
ActionStatus
String
请求处理的结果:
OK:表示处理成功
FAIL:表示失败
ErrorCode
Integer
错误码:
0:表示成功
非0:表示失败,非0取值的详细描述请参见 错误码说明
ErrorInfo
String
详细错误信息
ErrorDisplay
String
详细的客户端展示信息

错误码说明

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

接口调试工具

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

参考

添加分组(v4/sns/group_add
删除分组(v4/sns/group_delete