Docs Overview/
添加订阅者/

添加订阅者

功能说明

App 管理员可以通过该接口使用户订阅某个公众号，成为公众号的订阅成员。

接口调用说明

请求 URL 示例

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

最高调用频率

200次/秒。

请求包示例

{
    "Official_Account": "@TOA#_@TOA#dOEF",		// 要操作的公众号（必填）
    "SubscriberList": [		// 一次最多添加100个订阅者
        {
            "Subscriber_Account": "107867"	//待添加的订阅者UserID
        },
      	{
            "Subscriber_Account": "966582476"
        }
    ]
}

请求包字段说明

字段
类型
属性
说明
Official_Account
String
必填
需要订阅的公众号 ID。使用创建时接口返回的 OfficialAccountUserID 字段
SubscriberList
Array
必填
待添加的订阅者数组
Subscriber_Account
String
必填
待添加的订阅者 UserID

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "SubscriberList": [
        {
            "Subscriber_Account": "107867",
            "Result": 2
        },
        {
            "Subscriber_Account": "966582476",
            "Result": 1		// 加人结果：0 为失败；1 为成功；2 为已经订阅
        }
    ]
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果：
OK：表示处理成功
FAIL：表示失败
ErrorCode
Integer
错误码：
0：表示成功
非0表示失败
ErrorInfo
String
错误信息
SubscriberList
Array
返回添加的订阅者结果
Subscriber_Account
String
返回的订阅者 UserID
Result
Integer
加人结果：
0：失败
1：成功
2：已经关注此公众号

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。 公共错误码（60000到79999）参见 错误码 文档。 本 API 私有错误码如下：
错误码
含义说明
6017
请求参数非法，请修改后重试
10004
服务器内部错误，请重试
20001
请求包非法，请修改后重试
20005
服务器内部错误，请重试
130002
操作权限不足，请根据错误信息检查请求参数。
130004
公众号用户不存在，或者曾经存在过，但是目前已经被销毁
130006
此公众号的订阅者人数已满，请参见 价格说明 购买或升级相关套餐扩展公众号的订阅人数上限。（升级后需要调用 修改公众号资料 以修改支持的最大订阅者人数）
130007
公众号用户 ID 错误，请修改后重试
130008
公众号用户 ID 已经被使用
131000
此 AppId 暂未开通公众号服务
130010
超过订阅者加入的公众号数量限制，请检查并取消订阅的某些公众号。

参考

可能触发的回调

订阅公众号之前回调
订阅公众号之后的回调
公众号可订阅的人数已满之后回调