获取公众号的订阅成员资料

Recent Pages

获取公众号的订阅成员资料

最后更新时间：2024-07-16 11:29:54

功能说明
App 管理员可以通过该接口获取订阅某个公众号的所有用户信息.
接口调用说明
请求 URL 示例
https://xxxxxx/v4/official_account_open_http_svc/get_subscriber_info?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
硅谷：adminapiusa.im.qcloud.com
雅加达：adminapiidn.im.qcloud.com
v4/official_account_open_http_svc/get_subscriber_info
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员﻿
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig﻿
random
请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype
请求格式固定值为json
最高调用频率
200次/秒。
请求包示例
{   "Official_Account": "@TOA#_test_for_penn",
    "Limit": 50,    
    "Next": ""   
}
请求包字段说明
字段
类型
属性
说明
Official_Account
String
必填
需要获取的公众号 ID。使用创建时接口返回的OfficialAccountUserID字段
Limit
Integer
选填
一次最多获取多少个成员的资料，不得超过200。如果不填，则获取群内全部成员的信息
Next
String
必填
上一次拉取到的订阅者位置，首次调用填写""，续拉使用返回中的 Next 值
﻿
应答包体示例
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "Next": "TGSOTk=",		//续拉的标志位，若不为空，填入下一次请求的Next字段中
    "SubscriberNum": 780031,	// 订阅此公众号的总人数	
    "SubscriberList": [
        {
            "Subscriber_Account": "millaccount13356",		// 订阅者账号
            "SubscribeTime": 1698821747,		// 订阅的时间
            "CustomString": "",					//订阅者维度的自定义字段
            "MsgFlag": "AcceptAndNotify",		//订阅者的消息接收选项，和群成员类似
            "LastSendMsgTime": 0				//最后一次发消息的时间
        },
        {
            "Subscriber_Account": "millaccount13100",
            "SubscribeTime": 1698821690,
            "CustomString": "",
            "MsgFlag": "AcceptAndNotify",
            "LastSendMsgTime": 0
        }
      // 下面省略剩余的订阅者信息
      
    ]
}
应答包字段说明
字段
类型
说明
ActionStatus
String
请求处理的结果：
OK：表示处理成功
FAIL：表示失败
ErrorCode
Integer
错误码：
0：表示成功
非0：表示失败
ErrorInfo
String
错误信息
Next
String
续拉的标志位，最后一次拉取服务端的应答包返回 Next 为""，代表无后续订阅者信息，客户端应结束查询。
SubscriberNum
Integer
返回公众号下所有的订阅者人数
SubscriberList
Array
返回的订阅者列表，包括如下信息：
Subscriber_Account 订阅者账号
SubscribeTime  订阅的时间
CustomString 订阅者维度的自定义字段
MsgFlag  订阅者的消息接收选项，此字段和群成员的消息接收选项类似
LastSendMsgTime 最后一次发消息的时间
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码
含义说明
6017
请求参数非法，请修改后重试
10004
服务器内部错误，请重试
20001
请求包非法，请修改后重试
20005
服务器内部错误，请重试
130007
公众号用户 ID 错误，请修改后重试
130008
公众号用户 ID 已经被使用，请修改后重试
131000
此 AppId 暂未开通公众号服务，请开通后重试
130010
创建的公众号数量超过限制，请解散部分公众号或者进行服务升级
参考
﻿创建公众号﻿
﻿
﻿

联系我们

联系我们，为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持

tencent cloud

Recent Pages

获取公众号的订阅成员资料

功能说明

接口调用说明

请求 URL 示例

请求参数说明

最高调用频率

请求包示例

请求包字段说明

应答包体示例

应答包字段说明

错误码说明

参考

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？

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

字段	类型	属性	说明
Official_Account	String	必填	需要获取的公众号 ID。使用创建时接口返回的OfficialAccountUserID字段
Limit	Integer	选填	一次最多获取多少个成员的资料，不得超过200。如果不填，则获取群内全部成员的信息
Next	String	必填	上一次拉取到的订阅者位置，首次调用填写""，续拉使用返回中的 Next 值

错误码	含义说明
6017	请求参数非法，请修改后重试
10004	服务器内部错误，请重试
20001	请求包非法，请修改后重试
20005	服务器内部错误，请重试
130007	公众号用户 ID 错误，请修改后重试
130008	公众号用户 ID 已经被使用，请修改后重试
131000	此 AppId 暂未开通公众号服务，请开通后重试
130010	创建的公众号数量超过限制，请解散部分公众号或者进行服务升级

tencent cloud

注册

登录

Recent Pages

获取公众号的订阅成员资料

功能说明

接口调用说明

请求 URL 示例

请求参数说明

最高调用频率

请求包示例

请求包字段说明

应答包体示例

应答包字段说明

错误码说明

参考

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？