功能说明
App 管理员可以通过该接口获取用户订阅的所有公众号列表信息。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/official_account_open_http_svc/get_subscribed_official_account_list?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名： 中国： console.tim.qq.com新加坡： adminapisgp.im.qcloud.com首尔： adminapikr.im.qcloud.com法兰克福： adminapiger.im.qcloud.com硅谷： adminapiusa.im.qcloud.com雅加达： adminapiidn.im.qcloud.com |
v4/official_account_open_http_svc/get_subscribed_official_account_list | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数，取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
200次/秒。
请求包示例
{"Subscriber_Account": "107867", //订阅者"Limit": 200,"Offset": 0,"ResponseFilter":{ //过滤字段"OfficialAccountBaseInfoFilter":[ //公众号信息过滤字段"CreateTime","Name","Owner_Account","LastMsgTime","SubscriberNum","Introduction","FaceUrl","Organization","CustomString"],"SelfInfoFilter":[ //订阅者信息过滤字段"SubscribeTime","CustomString"]}}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
Subscriber_Account | String | 必填 | 需要修改信息的订阅者用户 ID |
Limit | Integer | 选填 | 单次拉取的公众号数目， 目前支持最大值为200，不填则默认是200 |
Offset | Integer | 选填 | 从第多少个公众号开始拉取 |
ResponseFilter | Object | 选填 | 分别包含 OfficialAccountBaseInfoFilter 和 SelfInfoFilter 两个过滤器； OfficialAccountBaseInfoFilter 表示需要拉取哪些公众号的基础信息字段，主要包括： CreateTime 公众号的创建时间 Name 公众号名称 Owner_Account公众号所属的用户 LastMsgTime 公众号内的最后一条消息时间 SubscriberNum 公众号目前的订阅者人数 Introduction 公众号简介 FaceUrl 公众号的头像Url Organization 公众号的所在组织 CustomString 公众号维度的自定义字段 如果不填，则拉取所有字段信息 SelfInfoFilter 表示需要拉取订阅者自己的相关信息，主要包括 SubscribeTime 订阅者订阅公众号的时间 CustomString 订阅者维度的自定义字段 如果不填，则拉取所有字段信息 |
应答包体示例
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"TotalCount": 8, //订阅公众号的总数量，和拉取的Limit没有关系"OfficialAccountInfoList": [ //返回的公众号列表{"Name": "test_mill_subscriber_OA","Official_Account": "@TOA#_test_mill_subscriber_OA","Owner_Account": "107867","LastMsgTime": 1698894911,"SubscriberNum": 499800,"Introduction": "This is test Introduction","FaceUrl": "http://this.is.face.url","Organization": "Tencent","CustomString": "test_custom_string","SelfInfo": {"SubscribeTime": 1700655351,"CustomString": ""}//...后续可能还有很多信息，这里只展示一个公众号信息],"CompleteFlag": 1, //是否拉取结束标志，1代表已结束，0代表未结束"Next": 0 //若拉取结束，返回0}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果： OK：表示处理成功 FAIL：表示失败 |
ErrorCode | Integer | 错误码： 0：表示成功 非0：表示失败 |
ErrorInfo | String | 错误信息 |
OfficialAccountInfoList | Array | 拉取到的公众号信息, 返回的结果是根据过滤器中设置的过滤字段进行过滤后的信息 |
TotalCount | Integer | 用户所订阅的公众号数量 |
CompleteFlag | Integer | 拉取是否结束的标志， 1：代表已拉取完毕 0：代表未拉取结束 |
Next | Integer | 下一次拉取的标识。若本次拉取未结束可以填入下一次拉取的Offset中作为分页拉取的偏移量 |
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码 | 含义说明 |
6017 | 请求参数非法，请修改后重试 |
10004 | 服务器内部错误，请重试 |
20001 | 请求包非法，请修改后重试 |
20005 | 服务器内部错误，请重试 |
130002 | 操作权限不足，请根据错误信息检查请求参数。 |
130004 | 公众号用户不存在，或者曾经存在过，但是目前已经被销毁 |
130007 | 公众号用户 ID 错误，请修改后重试 |
131000 | 此 AppId 暂未开通公众号服务 |
