# 接口文档总览

# 授权与 Token 相关接口

接口名称 说明
获取验证票据 获取component_verify_ticket的说明文档
启动 ticket 推送服务 该 API 用于启动 ticket 推送服务
获取令牌 该 API 用于获取第三方平台接口的调用凭据
获取预授权码 该 API 用于获取预授权码
使用授权码获取授权信息 该 API 用于换取公众号/小程序的授权信息
获取/刷新接口调用令牌 该 API 用于获取新的接口调用令牌
获取授权帐号信息 该 API 用于获取授权方的基本信息
授权变更通知推送 当公众号/小程序对第三方平台进行授权、取消授权、更新授权后,微信服务器会向第三方平台方的授权事件接收 URL(创建时由第三方平台时填写)以 POST 的方式推送相关通知

# openApi管理

接口名称 说明
清空 api 的调用quota 本接口用于清空公众号/小程序/第三方平台等接口的每日调用接口次数
查询 openAPI 调用quota 本接口用于查询公众号/小程序/第三方平台等接口的每日调用接口的额度以及调用次数
查询 rid 信息 本接口用于查询调用公众号/小程序/第三方平台等接口报错返回的 rid 详情信息,辅助开发者高效定位问题

# 第三方平台域名管理

接口名称 说明
设置第三方平台服务器域名 本接口用于配置第三方平台小程序服务器域名
获取第三方业务域名校验文件 本接口用于获取第三方平台小程序业务域名的校验文件
设置第三方平台业务域名 本接口用于配置第三方平台小程序业务域名

# 配置小程序用户隐私保护指引

接口名称 说明
设置小程序用户隐私保护指引 本接口用于配置第三方代开发小程序的用户隐私保护指引。可根据小程序实际情况进行完善。小程序发布后即向 c 端用户展示
查询小程序用户隐私保护指引 本接口用于查询第三方代开发小程序的用户隐私保护指引,也可以用来查询有哪些privacy_key可以进行配置
上传小程序用户隐私保护指引 本接口用于上传自定义的小程序的用户隐私保护指引

# 授权方账号管理

接口名称 说明
拉取授权方帐号基本信息 本接口用于拉取当前所有已授权的帐号基本信息
获取授权方选项信息 本接口用于获取授权方的公众号/小程序的选项设置信息
设置授权方选项信息 本接口用于设置授权方的公众号/小程序的选项信息

# 开放平台帐号管理

接口名称 说明
创建开放平台帐号并绑定公众号/小程序 本接口用于创建一个开放平台帐号,并将一个尚未绑定开放平台帐号的公众号/小程序绑定至该开放平台帐号
将公众号/小程序绑定到开放平台帐号下 本接口用于将一个尚未绑定开放平台帐号的公众号或小程序绑定至指定开放平台帐号
将公众号/小程序从开放平台帐号下解绑 本接口用于将一个公众号或小程序与指定开放平台帐号解绑
获取公众号/小程序所绑定的开放平台帐号 本接口用于获取公众号或小程序所绑定的开放平台帐号

# 代商家注册小程序的接口

接口名称 说明
快速注册企业小程序 本接口用于快速注册企业小程序
用公众号主体注册小程序 本文涉及的接口为复用公众号主体注册小程序以及换绑小程序管理员
快速注册个人小程序 本接口用于快速创建个人小程序

# 试用小程序的接口

接口名称 说明
创建试用小程序 本接口用于快速创建试用小程序
试用小程序快速认证 本接口用于通过企业法人人脸识别的方式快速将试用小程序进行认证
修改试用小程序名称 本接口用于修改试用小程序名称

# 小程序模板管理

接口名称 说明
获取代码草稿列表 本接口用于获取草稿箱中所有的草稿(临时代码模板)
将草稿添加到代码模板库 本接口用于将临时草稿选为持久的代码模板
获取代码模板列表 本接口用于将草稿箱中的某个代码版本添加到代码模板库中
删除指定代码模板 本接口用于删除指定的代码模板

# 小程序基础信息设置

接口名称 说明
获取基本信息 本接口用于获取获取小程序的基本信息
查询小程序是否绑定 open 帐号 本接口用于查询公众号或小程序是否绑定的开放平台帐号
设置服务器域名 本接口为授权给第三方的小程序配置服务器域名
设置业务域名 本接口为授权给第三方的小程序配置业务域名
设置名称 本接口用于设置小程序名称
微信认证名称检测 本接口用于检测微信认证的名称是否符合规则
名称审核结果事件推送 小程序改名的审核结果会向消息与事件接收 URL 推送相关通知
查询改名审核状态 本接口用于查询改名审核状态
修改头像 本接口用于修改小程序的头像
修改简介 本接口用于修改功能介绍
查询搜索设置 本接口用于查询小程序当前是否可被搜索
修改搜索设置 调用本接口可以修改小程序是否可被搜索
获取数据拉取配置 调用本接口可以修改功能介绍
设置预拉取数据 调用本接口可以设置预拉取数据
设置周期性拉取数据 调用本接口可以设置周期性拉取数据

# 半屏小程序管理

接口名称 说明
获取半屏小程序调用列表 本接口用于半屏小程序调用列表
获取半屏小程序授权列表 本接口用于获取半屏小程序授权列表
添加半屏小程序 本接口用于添加半屏小程序
删除调用的半屏小程序 本接口用于删除调用的半屏小程序
取消授权半屏小程序 本接口用于取消授权半屏小程序
设置半屏小程序授权方式 本接口用于设置半屏小程序授权方式

# 小程序类目管理

接口名称 说明
获取可设置的所有类目 本接口用于获取该小程序允许设置的所有类目且仅支持获取一级类目和二级类目
获取已设置的所有类目 本接口用于获取小程序已设置的所有类目
获取不同主体类型的类目 本接口用于获取不同主体对应的可设置的类目信息
添加类目 调用本接口可以给小程序添加类目
删除类目 调用本接口可以删除小程序的指定类目
修改类目资质信息 本接口用于修改类目资质信息
获取审核时可填写的类目信息 本接口可获取已设置的二级类目及用于代码审核的可选三级类目
类目审核结果事件推送 添加类目的审核结果会向消息与事件接收 URL 推送相关通知

# 小程序成员管理

接口名称 说明
绑定体验者 本接口用于将运营者的个人微信号添加到该小程序的体验者名单中
解除绑定体验者 本接口用于将特定微信用户从小程序的体验者列表中解绑
获取已绑定的体验者列表 本接口用于获取小程序所有已绑定的体验者列表

# 小程序代码管理

接口名称 说明
上传代码 调用本接口可以为已授权的小程序上传代码
获取已上传的代码的页面列表 通过本接口可以获取由第三方平台上传小程序代码的页面列表
获取体验版二维码 调用本接口可以获取小程序的体验版二维码
提交审核 调用本接口,将上传的代码提交审核
代码审核结果推送 当小程序有审核结果后,微信服务器会向第三方平台方的消息与事件接收 URL(创建第三方平台时填写)以 POST 的方式推送相关通知
查询指定版本的审核状态 调用本接口可以查询指定发布审核单的审核状态
查询最新一次提交的审核状态 调用本接口可以查询最新一次提审单的审核状态
审核撤回 调用本接口可以撤回当前的代码审核单
发布已通过审核的小程序 调用本接口可以发布最后一个审核通过的小程序代码版本
查询小程序版本信息 调用本接口可以查询小程序的体验版和线上版本信息
小程序版本回退 调用本接口可以将小程序的线上版本进行回退
获取可回退的小程序版本 调用本接口可以获取可回退的小程序版本(最多保存最近发布或回退的5个版本)
分阶段发布 本接口是创建一个灰度发布的计划,可以控制发布的节奏,避免一上线就影响到所有的用户。可以多次调用本次接口,将灰度的比例(gray_percentage)逐渐增大
查询分阶段发布详情 该接口用于查询当前分阶段发布详情
取消分阶段发布 调用本接口取消分阶段发布
修改小程序服务状态 本接口用于修改小程序服务状态(仅供第三方代小程序调用)
查询小程序服务状态 调用本接口可以查询小程序的服务状态(仅供第三方代小程序调用)
查询当前设置的最低基础库版本及各版本用户占比 调用本接口可以查询小程序当前设置的最低基础库版本,以及小程序在各个基础库版本的用户占比
设置最低基础库版本 调用本接口可以设置小程序的最低基础库支持版本
查询服务商的当月提审限额(quota)和加急次数 调用该接口,查询当月平台分配的提审限额和剩余可提审次数,以及当月分配的审核加急次数和剩余加急次数
加急审核申请 本接口用于对已经提审的小程序进行加急操作

# 违规和申诉管理

接口名称 说明
获取小程序违规处罚记录 调用本 API 可以获取小程序的违规处罚记录
获取小程序申诉记录 调用本 API 可以获取小程序的申诉记录
小程序申诉记录推送 当小程序发起申诉或者申诉审核状态改变后,微信服务器会向第三方平台的消息与事件接收 URL(创建时由第三方平台填写)以 POST 的方式推送该通知

# 扫码关注公众号

接口名称 说明
获取展示的公众号信息 使用本接口可以获取扫码关注组件所展示的公众号信息
获取可以用来设置的公众号列表 通过本接口可以获取扫码关注组件允许展示的公众号列表
设置展示的公众号信息 使用本接口可以设置扫码关注组件所展示的公众号信息

# 扫普通链接二维码打开小程序

接口名称 说明
获取已设置的二维码规则 通过本接口可以获取已设置的普通链接二维码规则
获取校验文件名称和内容 通过本接口下载随机校验文件,并将文件上传至服务器指定位置的目录下,方可通过所属权校验
增加或修改二维码规则 通过本接口可以增加或修改普通链接二维码规则
发布已设置的二维码规则 调用本接口将二维码规则发布生效,发布后现网用户扫码命中该规则的普通链接二维码时将跳转到正式版小程序指定的页面
删除已设置的二维码规则 该接口用于删除已设置的二维码规则
将二维码长链接转成短链接 调用本 API 可以将一条长链接转成短链接

# 其他小程序接口

接口名称 说明
小程序登录 第三方平台开发者的服务器使用登录凭证(code)以及第三方平台的 component_access_token 可以代替小程序实现登录功能 获取 session_key 和 openid
订阅消息设置 订阅消息设置接口详情请参考本文
插件管理 插件管理接口详情请参考本文
微信物流服务 - 快递发货接口(原物流助手) 物流助手接入接口详情请参考本文
微信物流服务 - 即时配送接口 即时配送接口,微信官方免费接口,旨在解决餐饮、生鲜、超市等小程序的外卖配送需求
微信物流服务 - 物流查询组件 通过该接口,第三方开发者可帮助商家发起物流查询组件的申请
微信物流服务 - 物流消息功能 通过该接口,第三方开发者可帮助商家发起物流消息功能的申请
数据分析 数据分析接口详情请参考本文
小程序直播 - 申请开通直播 通过该接口,第三方开发者可帮助商家发起小程序直播功能的申请
小程序直播 - 小程序直播接口 小程序直播接口详情请参考本文
内容安全 内容安全接口详情请参考本文
广告 广告接口详情请参考本文
统一服务消息 统一服务消息接口详情请参考本文
动态消息 动态消息接口详情请参考本文
客服消息 客服消息接口详情请参考本文
运维中心 运维中心接口详情请参考本文
附近的小程序 附近的小程序接口详情请参考本文
小程序搜索 小程序搜索接口详情请参考本文
获取小程序scheme 获取小程序 scheme 码接口详情请参考本文
获取 URL Link 获取 URL Link接口详情请参考本文
获取 short Link 获取 URL Link接口详情请参考本文
获取 小程序码 获取 URL Link接口详情请参考本文
支付后获取用户 Unionid 调用本接口前需要用户完成支付,用户支付完成后,第三方平台可以代理小程序获取该用户的 unionid,无需用户授权

# 公众号相关接口

接口名称 说明
小程序管理 本文接口涉及获取公众号关联的小程序、关联小程序、解除已关联的小程序
微信广告接口 在微信公众号授权给服务商/第三方平台后,服务商/第三方平台可通过微信广告接口来进行应用程序的开发,实现对微信朋友圈和公众号广告的投放、管理及报表查看等功能
微信商品库接口 第三方获得商家授权微信商品库权限后,可代商家完成商品的导入及更新、查询系统的搭建
扫服务号二维码打开小程序 - 获取已设置的服务号二维码规则 该接口用于获取小程序已经设置的二维码规则
扫服务号二维码打开小程序 - 增加或修改服务号二维码规则 该接口用于将服务号的二维码增加或修改为小程序的二维码规则
扫服务号二维码打开小程序 - 发布已设置的服务号二维码规则 需要先添加二维码规则,然后调用本接口将二维码规则发布生效,发布后现网用户扫码命中该规则的服务号的二维码时将跳转到正式版小程序指定的页面
扫服务号二维码打开小程序 - 删除已设置的服务号二维码规则 该接口用于删除已设置的二维码规则

# 微信云托管的接口

接口名称 说明
创建微信云托管环境 通过本接口可以创建微信云托管环境
查询微信云托管环境信息 通过本接口可以查询微信云托管环境信息
创建云应用服务 通过本接口可以创建云应用服务
创建服务版本 通过本接口可以创建服务版本
滚动更新服务版本 通过本接口可以滚动更新服务版本
删除服务版本 通过本接口可以删除服务版本
全量发布 通过本接口可以全量发布版本
开通微服务 通过本接口可以开通微服务

# 批量云开发的接口

接口名称 说明
创建环境 通过本接口可以创建环境
使用腾讯云环境 通过本接口可以将腾讯云控制台创建的环境变更为微信小程序的环境
查询环境信息 通过本接口可以获取环境列表
环境共享 通过本接口可以将环境共享给小程序
查询共享的环境ID 通过本接口可以批量查询小程序被该服务商共享的环境id
批量创建云函数 通过本接口可以批量创建云函数
批量更新云函数代码 通过本接口可以批量更新云函数代码
更新云函数配置 通过本接口可以更新云函数配置
删除云函数 通过本接口可以删除云函数
获取云函数列表 通过本接口可以获取云函数列表
获取触发器 通过本接口可以获取触发器
批量更新触发器 通过本接口可以批量更新触发器
触发云函数 通过本接口可以触发云函数
查询集合 通过本接口可以数据库查询集合
增加集合 通过本接口可以数据库增加集合
删除集合 通过本接口可以数据库删除集合
插入记录 通过本接口可以数据库插入记录
删除记录 通过本接口可以数据库删除记录
更新记录 通过本接口可以数据库更新记录
查询记录 通过本接口可以数据库查询记录
增加索引 通过本接口可以数据库创建索引
删除索引 通过本接口可以数据库删除索引
数据库导入 通过本接口可以数据库导入
数据库导出 通过本接口可以数据库导出
数据库导入/导出状态查询 通过本接口可以数据库导入/导出状态查询
数据库聚合 通过本接口可以数据库聚合
获取数据库操作权限 通过本接口可以获取数据库操作权限
修改数据库操作权限 通过本接口可以修改数据库操作权限
获取文件上传链接 通过本接口可以获取上传文件链接
获取下载文件链接 通过本接口可以获取下载文件链接
删除文件 通过本接口可以删除文件
查看文件列表 通过本接口可以查看文件列表
开通静态网站 通过本接口可以开通静态网站
查看静态网站状态 通过本接口可以查看静态网站状态
获取静态网站文件列表 通过本接口可以配置获取静态网站文件列表
获取上传静态网站文件链接 通过本接口可以获取上传静态网站文件链接

# 普通云开发的接口

接口名称 说明
开通云开发 通过本接口可以开通云开发
管理微信令牌权限 通过本接口可以开启或关闭cloudbase_access_token的使用权限
获取腾讯云 API 调用凭证 通过本接口可以获取腾讯云 API 调用凭证
查询是否绑定手机号 通过本接口可以查询小程序是否绑定了手机号
获取云环境信息 通过本接口可以获取已有的云环境信息
创建云环境 通过本接口可以创建云环境
使用腾讯云环境 通过本接口可以将腾讯云控制台创建的环境变更为微信小程序的环境
共享环境 通过本接口可以共享环境
上传消息推送配置 通过本接口可以上传消息推送配置
获取消息推送配置 通过本接口可以获取消息推送配置
创建云函数 通过本接口可以创建云函数
获取代码保护密钥 通过本接口可以获取代码保护密钥
获取上传凭证 通过本接口可以获取上传云函数签名header
上传云函数代码包 通过本接口可以上传云函数
获取云函数列表 通过本接口可以获取云函数列表
获取云函数下载地址 通过本接口可以获取云函数下载地址
上传云函数配置 通过本接口可以上传云函数配置
[获取云函数配置]https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/cloudbase/common/getFuncConfig.html) 通过本接口可以获取云函数配置
触发云函数 通过本接口可以触发云函数
删除文件 通过本接口可以删除文件
获取文件下载链接 通过本接口可以获取文件下载链接
获取文件上传链接 通过本接口可以获取文件上传链接
数据库插入记录 通过本接口可以数据库插入记录
数据库聚合 通过本接口可以数据库聚合
新增集合 通过本接口可以新增集合
删除集合 通过本接口可以删除集合
获取特定云环境下集合信息 通过本接口可以获取特定云环境下集合信息
统计集合记录数 通过本接口可以统计集合记录数或统计查询语句对应的结果记录数
数据库删除记录 通过本接口可以数据库删除记录
数据库导出 通过本接口可以进行数据库导出
数据库导入 通过本接口可以进行数据库导入
数据库迁移状态查询 通过本接口可以数据库迁移状态查询
数据库查询记录 通过本接口可以数据库查询记录
数据库更新记录 通过本接口可以数据库更新记录
变更数据库索引 通过本接口可以变更数据库索引
查询绑定商户号列表 通过本接口可以查询授权绑定的商户号列表
绑定商户号 通过本接口可以申请商户号授权