# 草稿箱开关设置
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:draft_switch
本接口用于设置或查询草稿箱和发布功能的开关状态。
- 内测期间会逐步放量,任何用户都可能会自动打开;
- 此开关开启后不可逆,换言之,无法从开启的状态回到关闭;
- 内测期间,无论开关开启与否,旧版的图文素材API,以及新版的草稿箱、发布等API均可以正常使用;
- 在内测结束之后,所有用户都将自动开启,即草稿箱、发布等功能将对所有用户开放,本开关连同之前的图文素材API也将随后下线。
# 其他说明
由于草稿箱和发布功能仍处于内测阶段,若公众号没有被灰度覆盖,可能无法体验草稿箱和发布功能。为了解决这个问题,我们在上述API接口的基础上,设了这样一个开关:当一个公众号选择开启后,该账号在微信公众平台后台(mp.weixin.qq.com)上的图文素材库将升级为草稿箱,并可以在微信公众平台后台使用发布功能。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cgi-bin/draft/switch?access_token=ACCESS_TOKEN&checkonly=CHECKONLY
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:11、100
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
checkonly | number | 否 | 1 | 仅检查状态时传1 |
# 请求体 Request Payload
无
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
is_open | number | 仅 errcode==0 (即调用成功) 时返回,0 表示开关处于关闭,1 表示开启成功(或开关已开启) |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
# 5.1 设置开关状态
请求示例
https://api.weixin.qq.com/cgi-bin/draft/switch?access_token=ACCESS_TOKEN
返回示例
{
"errcode": 0,
"errmsg": "ok"
}
# 5.2 查询开关状态
请求示例
https://api.weixin.qq.com/cgi-bin/draft/switch?access_token=ACCESS_TOKEN&checkonly=1
返回示例
{
"errcode": 0,
"errmsg": "ok",
"is_open": 0
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
0 | ok | 成功 |
# 7. 适用范围
本接口在不同账号类型下的可调用情况:
公众号 | 服务号 |
---|---|
✔ | ✔ |
- ✔:该账号可调用此接口
- 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;