创建公众号之前回调

功能说明

App 后台可以通过该回调实时查看用户创建公众号的请求,包括后台可以拒绝用户创建公众号的请求。

注意事项

要启用回调,必须配置回调 URL,并打开本条回调协议对应的开关,配置方法详细请参见 第三方回调配置 文档。
回调的方向是即时通信 IM 后台向 App 后台发起 HTTP POST 请求。
App 后台在收到回调请求之后,务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。
其他安全相关事宜请参见 第三方回调简介:安全考虑 文档。

可能触发该回调的场景

App 管理员通过 REST API 创建公众号。

回调发生时机

即时通信 IM 后台准备创建公众号之前。

接口说明

请求 URL 示例

以下示例中 App 配置的回调 URL 为 https://www.example.com示例:
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform

请求参数说明

参数
说明
https
请求协议为 HTTPS,请求方式为 POST。
www.example.com
回调 URL。
SdkAppid
创建应用时在即时通信 IM 控制台分配的 SDKAppID。
CallbackCommand
固定为:OfficialAccount.CallbackBeforeCreateOfficialAccount。
contenttype
固定值为 JSON。
ClientIP
客户端 IP,格式如:127.0.0.1。
OptPlatform
客户端平台,取值请参见 第三方回调简介:回调协议 中 OptPlatform 的参数含义。

请求包示例

{
"CallbackCommand": "OfficialAccount.CallbackBeforeCreateOfficialAccount", // 回调命令
"Operator_Account": "107867", // 操作者
"Owner_Account": "107867", // 创建者
"Name": "TestOfficialAccount", // 公众号的名称
"EventTime": 1670574414123// 毫秒级别,事件触发时间戳
}

请求包字段说明

对象
介绍
功能
CallbackCommand
String
回调命令。
Operator_Account
String
发起创建请求的操作者 UserID。
Owner_Account
String
公众号的创建者,也就是公众号的拥有者。
Name
String
请求创建的公众号的名称。
EventTime
Integer
事件触发的毫秒级别时间戳。

应答包示例

允许创建

允许用户创建公众号。
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0 // 允许创建
}

禁止创建

不允许用户创建公众号,公众号将不会被创建,同时给调用方返回错误码:20006。
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 1 // 拒绝创建
}

应答包字段说明

字段
类型
属性
说明
ActionStatus
String
必填
请求处理的结果:
OK:表示处理成功
FAIL:表示失败
ErrorCode
Integer
必填
错误码,0为允许创建;1为拒绝创建,若业务希望使用自己的错误码拒绝用户建群,将错误码 ErrorCode 和 ErrorInfo 传递至客户端,请将错误码 ErrorCode 设置在 [120001, 130000] 区间内。
ErrorInfo
String
必填
错误信息。

参考

REST API: 创建公众号