# 第三方平台调用凭证
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 启动票据推送服务 | /cgi-bin/component/api_start_push_ticket | 该 API 用于启动ticket推送服务 |
| 获取预授权码 | /cgi-bin/component/api_create_preauthcode | 该接口用于获取预授权码(preauthcode)是第三方平台方实现授权托管的必备信息,每个预授权码有效期为 1800秒 |
| 获取授权账号调用令牌 | /cgi-bin/component/api_authorizer_token | 该接口用于获取授权账号的authorizeraccesstoken |
| 获取刷新令牌 | /cgi-bin/component/api_query_auth | 当用户在第三方平台授权页中完成授权流程后,第三方平台开发者可以在回调 URI 中通过 URL 参数获取授权码(authorizationcode) |
| 获取令牌 | /cgi-bin/component/api_component_token | 令牌(componentaccesstoken)是第三方平台接口的调用凭据 |
# 授权账号管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 拉取已授权的账号信息 | /cgi-bin/component/api_get_authorizer_list | 使用本 API 拉取当前所有已授权的账号基本信息 |
| 获取授权账号详情 | /cgi-bin/component/api_get_authorizer_info | 该 API 用于获取授权方的基本信息,包括头像、昵称、账号类型、认证类型、原始ID等信息 |
| 设置授权方选项信息 | /cgi-bin/component/set_authorizer_option | 本 API 用于设置授权方的公众号/小程序的选项信息,如:地理位置上报,语音识别开关,多客服开关 |
| 获取授权方选项信息 | /cgi-bin/component/get_authorizer_option | 本 API 用于获取授权方的公众号/小程序的选项设置信息,如:地理位置上报,语音识别开关,多客服开关 |
# openApi管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 重置API调用次数 | /cgi-bin/clear_quota | 本接口是通过access_token清空服务端接口的每日调用接口次数 |
| 查询API调用额度 | /cgi-bin/openapi/quota/get | 本接口用于查询服务端接口的的每日调用接口的额度,调用次数,频率限制 |
| 查询rid信息 | /cgi-bin/openapi/rid/get | 本接口用于查询调用服务端接口报错返回的rid详情信息,辅助开发者高效定位问题 |
| 使用AppSecret重置第三方平台API调用次数 | /cgi-bin/component/clear_quota/v2 | 本接口用于清空公众号/小程序/第三方等接口的每日调用接口次数 |
# 第三方平台管理
# 模板库管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 获取草稿箱列表 | /wxa/gettemplatedraftlist | 通过本接口,可以获取第三方平台草稿箱中所有的草稿; 说明,草稿是由第三方平台的开发小程序在使用微信开发者工具上传的 |
| 将草稿添加到模板库 | /wxa/addtotemplate | 该接口用于将草稿添加到模板库设置为持久的代码模板 |
| 获取模板列表 | /wxa/gettemplatelist | 通过该接口可以获取模板库里的模板列表信息 |
| 删除代码模板 | /wxa/deletetemplate | 通过该接口可以删除指定的模板 |
# 域名管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 设置第三方平台服务器域名 | /cgi-bin/component/modify_wxa_server_domain | 本接口用于配置第三方平台小程序服务器域名 |
| 获取第三方平台业务域名校验文件 | /cgi-bin/component/get_domain_confirmfile | 本接口用于获取第三方平台小程序业务域名的校验文件 |
| 设置第三方平台业务域名 | /cgi-bin/component/modify_wxa_jump_domain | 本接口用于配置第三方平台小程序业务域名 |
# 开放平台账号管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 绑定开放平台账号 | /cgi-bin/open/bind | 该 API 用于将一个尚未绑定开放平台账号的公众号或小程序绑定至指定开放平台账号上 |
| 解除绑定开放平台账号 | /cgi-bin/open/unbind | 该 API 用于将一个公众号或小程序与指定开放平台账号解绑 |
| 获取开放平台账号 | /cgi-bin/open/get | 该 API 用于获取公众号或小程序所绑定的开放平台账号 |
| 创建开放平台账号 | /cgi-bin/open/create | 该 API 用于创建一个开放平台账号,并将一个尚未绑定开放平台账号的公众号/小程序绑定至该开放平台账号上 |
# 代商家注册小程序
# 注册企业小程序
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 快速注册企业小程序 | /cgi-bin/component/fastregisterweapp | 本接口用于给第三方快速注册企业小程序 |
# 复用公众号注册小程序
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 复用公众号主体快速注册小程序 | /cgi-bin/account/fastregister | 本接口用于第三方复用公众号主体快速注册小程序 |
# 注册个人小程序
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 快速注册个人小程序 | /wxa/component/fastregisterpersonalweapp | 本接口用于第三方快速注册个人小程序 |
# 注册试用小程序
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 修改试用小程序名称 | /wxa/setbetaweappnickname | 该接口用于修改试用小程序名称 |
| 试用小程序快速转正 | /wxa/verifybetaweapp | 该接口用于通过企业法人人脸识别的方式快速将试用小程序进行认证 |
| 注册试用小程序 | /wxa/component/fastregisterbetaweapp | 该接口用于快速创建试用小程序 |
# 代商家管理小程序
# 小程序登录
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 小程序登录 | /sns/component/jscode2session | 第三方平台开发者的服务器使用登录凭证code以及第三方平台的 componentaccesstoken 可以代替小程序实现登录功能 获取 sessionkey |
# 基础信息管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 获取基本信息 | /cgi-bin/account/getaccountbasicinfo | 调用本 API 可以获取小程序的基本信息,所属权限集为30 |
| 查询绑定的开放平台账号 | /cgi-bin/open/have | 该 API 用于查询公众号或小程序是否绑定的开放平台账号 |
| 小程序名称检测 | /cgi-bin/wxverify/checkwxverifynickname | 调用本 API 可以检测微信认证的名称是否符合规则 |
| 设置小程序名称 | /wxa/setnickname | 调用本接口可以设置小程序名称,当名称没有命中关键词,则直接设置成功;当名称命中关键词,需提交证明材料,并需要审核 |
| 查询小程序名称审核状态 | /wxa/api_wxa_querynickname | 调用设置名称接口,如果需要审核,会返回审核单 id(audit_id),使用本接口可以查询改名审核状态 |
| 设置小程序介绍 | /cgi-bin/account/modifysignature | 调用本接口可以修改功能介绍 |
| 获取搜索状态 | /wxa/getwxasearchstatus | 通过本接口可以查询小程序当前是否可被搜索 |
| 设置搜索状态 | /wxa/changewxasearchstatus | 通过本接口修改小程序是否可被搜索,可以先查询小程序当前的搜索状态设置再决定是否修改 |
| 数据预拉取和数据周期性更新 | /wxa/fetchdatasetting | 调用本接口可以获取数据预拉取和数据周期性更新配置、设置预拉取数据、设置周期性拉取数据 |
| 修改头像 | /cgi-bin/account/modifyheadimage | 调用本接口可以修改小程序的头像 |
| 查询开放平台账号是否与小程序同主体 | /cgi-bin/open/sameentity | 该 API 用于查询公众号或小程序绑定的开放平台账号是否与当前公众号/小程序同主体 |
| 获取订单页path信息 | /wxa/security/getorderpathinfo | 该接口用于获取订单页path信息 |
| 申请设置订单页path信息 | /wxa/security/applysetorderpathinfo | 该接口用于申请设置订单页path信息 |
# 小程序微信认证
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 小程序认证 | /wxa/sec/wxaauth | 小程序认证 |
| 小程序认证进度查询 | /wxa/sec/queryauth | 小程序认证进度查询 |
| 小程序认证上传补充材料 | /wxa/sec/uploadauthmaterial | 小程序认证上传补充材料 |
| 小程序认证重新提审 | /wxa/sec/reauth | 小程序认证打被回后重新提审接口 |
| 查询个人认证身份选项列表 | /wxa/sec/authidentitytree | 认证身份职业信息查询 |
# 小程序备案
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 查询人脸核身任务状态 | /wxa/icp/query_icp_verifytask | 该接口用于查询人脸核身任务的状态和结果 |
| 发起小程序管理员人脸核身 | /wxa/icp/create_icp_verifytask | 发起备案小程序管理员人脸核身,调用该接口时会向小程序的管理员发送一条备案人脸核身通知,管理员点击该通知即可进行人脸核身 |
| 上传小程序备案媒体材料 | /wxa/icp/upload_icp_media | 备案小程序需要提交图片或视频媒体材料,使用该接口完成媒体材料上传 |
| 撤回小程序备案申请 | /wxa/icp/cancel_apply_icp_filing | 使用该接口撤回正在流程中的备案申请 |
| 申请小程序备案 | /wxa/icp/apply_icp_filing | 使用该接口申请小程序备案 |
| 注销小程序备案 | /wxa/icp/cancel_icp_filing | 使用该接口注销已经备案好的小程序备案 |
| 获取小程序备案状态及驳回原因 | /wxa/icp/get_icp_entrance_info | 使用该接口获取小程序备案状态,如果小程序未备案通过,则返回其驳回原因 |
| 获取小程序已备案详情 | /wxa/icp/get_online_icp_order | 使用该接口获取小程序已备案详情 |
| 获取小程序服务内容类型 | /wxa/icp/query_icp_service_content_types | 使用该接口获取小程序服务内容类型定义 |
| 获取证件类型 | /wxa/icp/query_icp_certificate_types | 使用该接口获取证件类型定义 |
| 获取区域信息 | /wxa/icp/query_icp_district_code | 使用该接口查询省市区的区域信息 |
| 获取前置审批项类型 | /wxa/icp/query_icp_nrlx_types | 使用该接口获取小程序备案前置审批项类型定义 |
| 获取单位性质 | /wxa/icp/query_icp_subject_types | 使用该接口获取单位性质定义 |
| 获取小程序备案媒体材料 | /wxa/icp/get_icp_media | 用于小程序备案过程中获取所上传的图片或视频媒体材料 |
# 小程序认证及备案
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 查询人脸核身任务状态 | /wxa/icp/query_icp_verifytask | 该接口用于查询人脸核身任务的状态和结果 |
| 发起小程序管理员人脸核身 | /wxa/icp/create_icp_verifytask | 发起备案小程序管理员人脸核身,调用该接口时会向小程序的管理员发送一条备案人脸核身通知,管理员点击该通知即可进行人脸核身 |
| 申请小程序认证及备案 | /wxa/sec/submit_auth_and_icp | 使用该接口可一步申请小程序认证及备案 |
| 查询小程序认证及备案进度 | /wxa/sec/query_auth_and_icp | 查询小程序认证及备案进度 |
# 小程序域名管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 配置小程序服务器域名 | /wxa/modify_domain | 本接口用于配置小程序服务器域名 |
| 配置小程序业务域名 | /wxa/setwebviewdomain | 本接口用于配置小程序业务域名 |
| 快速配置小程序服务器域名 | /wxa/modify_domain_directly | 该接口用于配置小程序服务器域名,不再需要先将域名配置到第三方平台,可通过该接口直接进行配置到授权小程序 |
| 获取业务域名校验文件 | /wxa/get_webviewdomain_confirmfile | 该接口用于获取配置小程序业务域名的校验文件,需要将该校验文件放置在根域名目录下 |
| 快速配置小程序业务域名 | /wxa/setwebviewdomain_directly | 该接口用于配置小程序业务域名,不再需要先将域名配置到第三方平台,可通过该接口直接进行配置到授权小程序 |
| 获取发布后生效服务器域名列表 | /wxa/get_effective_domain | 该接口用于获取通过旧接口以及新接口配置的服务器域名在发布上线后真实生效的域名列表 |
| 获取发布后生效业务域名列表 | /wxa/get_effective_webviewdomain | 该接口用于获取通过旧接口以及新接口配置的业务域名在发布上线后真实生效的域名列表 |
| 获取DNS预解析域名 | /wxa/get_prefetchdnsdomain | 该接口用于获取DNS预解析域名 |
| 设置DNS预解析域名 | /wxa/set_prefetchdnsdomain | 该接口用于设置DNS预解析域名 |
# 小程序类目管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 获取可设置的所有类目 | /cgi-bin/wxopen/getallcategories | 本接口可以获取该小程序允许设置的所有类目且仅支持获取一级类目和二级类目,注意不同主体所允许设置的类目不同 |
| 获取已设置的所有类目 | /cgi-bin/wxopen/getcategory | 使用本接口获取小程序已设置的所有类目 |
| 获取不同类型主体可设置的类目 | /cgi-bin/wxopen/getcategoriesbytype | 本接口用于获取不同主体对应的可设置的类目信息 |
| 添加类目 | /cgi-bin/wxopen/addcategory | 调用本接口可以给小程序添加类目,添加的类目需要在所有可设置的类目列表中 |
| 删除类目 | /cgi-bin/wxopen/deletecategory | 调用本接口可以删除小程序的指定类目 |
| 修改类目资质信息 | /cgi-bin/wxopen/modifycategory | 通过获取已设置的类目列表接口可以获取当前小程序已设置的类目列表 |
| 获取类目名称信息 | /wxa/get_category | 接口可获取已设置的二级类目及用于代码审核的可选三级类目 |
# 用户隐私保护指引管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 设置小程序用户隐私保护指引 | /cgi-bin/component/setprivacysetting | 本接口用于配置第三方代开发小程序的用户隐私保护指引 |
| 获取小程序用户隐私保护指引 | /cgi-bin/component/getprivacysetting | 本接口用于查询第三方代开发小程序的用户隐私保护指引,也可以用来查询有哪些privacy_key可以进行配置 |
| 上传小程序用户隐私保护指引 | /cgi-bin/component/uploadprivacyextfile | 本接口用于上传自定义的小程序的用户隐私保护指引 |
# 地理位置接口申请
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 申请地理位置接口 | /wxa/security/apply_privacy_interface | 该接口用于申请地理位置接口 |
| 获取地理位置接口列表 | /wxa/security/get_privacy_interface | 该接口用于获取“需申请并审核通过”后才可使用的接口列表 |
# 小程序成员管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 绑定体验者 | /wxa/bind_tester | 本接口用于将微信用户绑定为小程序体验成员 |
| 解除绑定体验者 | /wxa/unbind_tester | 调用本接口可以将特定微信用户从小程序的体验者列表中解绑 |
| 获取体验者列表 | /wxa/memberauth | 通过本接口可以获取小程序所有已绑定的体验者列表 |
# 小程序代码管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 上传代码并生成体验版 | /wxa/commit | 本接口用于上传第三方代开发小程序的代码并生成体验版 |
| 获取已上传的代码页面列表 | /wxa/get_page | 通过本接口可以获取由commit接口上传代码的页面列表 |
| 获取体验版二维码 | /wxa/get_qrcode | 调用本接口可以获取小程序的体验版二维码 |
| 提交代码审核 | /wxa/submit_audit | 在调用commit接口为小程序上传代码后,可以调用本接口,将上传的代码提交审核 |
| 查询审核单状态 | /wxa/get_auditstatus | 通过接口提交代码审核后,调用本接口可以查询指定发布审核单的审核状态 |
| 撤回代码审核 | /wxa/undocodeaudit | 调用本接口可以撤回当前的代码审核单 |
| 发布已通过审核的小程序 | /wxa/release | 调用本接口可以发布最后一个审核通过的小程序代码版本 |
| 小程序版本回退 | /wxa/revertcoderelease | 调用本接口可以将小程序的线上版本进行回退 |
| 分阶段发布 | /wxa/grayrelease | 发布小程序release接口是全量发布,会影响到现网的所有用户 |
| 获取分阶段发布详情 | /wxa/getgrayreleaseplan | 该接口用于查询当前分阶段发布详情 |
| 设置小程序服务状态 | /wxa/change_visitstatus | 本接口用于修改小程序服务状态(仅供第三方代小程序调用) |
| 取消分阶段发布 | /wxa/revertgrayrelease | 在小程序分阶段发布期间,可以随时调用本接口取消分阶段发布 |
| 查询小程序服务状态 | /wxa/getvisitstatus | 调用本接口可以查询小程序的服务状态 |
| 查询各版本用户占比 | /cgi-bin/wxopen/getweappsupportversion | 调用本接口可以查询小程序当前设置的最低基础库版本,以及小程序在各个基础库版本的用户占比 |
| 设置最低基础库版本 | /cgi-bin/wxopen/setweappsupportversion | 调用本接口可以设置小程序的最低基础库支持版本,可以通过“查询各版本用户占比”接口先查询当前小程序在各个基础库的用户占比辅助进行决策 |
| 查询服务商审核额度 | /wxa/queryquota | 服务商可以调用该接口,查询当月平台分配的提审限额和剩余可提审次数,以及当月分配的审核加急次数和剩余加急次数 |
| 加急代码审核 | /wxa/speedupaudit | 有加急次数的第三方可以通过该接口,对已经提审的小程序进行加急操作,加急后的小程序预计2-12小时内审完 |
| 查询小程序版本信息 | /wxa/getversioninfo | 调用本接口可以查询小程序的体验版和线上版本信息 |
| 查询最新一次审核单状态 | /wxa/get_latest_auditstatus | 调用本接口可以查询最新一次提审单的审核状态 |
| 上传提审素材 | /wxa/uploadmedia | 调用本接口可将小程序页面截图和操作录屏上传,提审时带上相关参数,可以帮助审核人员判断 |
| 获取隐私接口检测结果 | /wxa/security/get_code_privacy_info | 该接口获得隐私接口检测结果 |
# 半屏小程序管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 添加半屏小程序 | /wxaapi/wxaembedded/add_embedded | 本接口用于添加半屏小程序 |
| 删除半屏小程序 | /wxaapi/wxaembedded/del_embedded | 用本接口可以删除已经获得授权调用的半屏小程序 |
| 取消授权小程序 | /wxaapi/wxaembedded/del_authorize | 调用本接口可以取消已经授权的小程序 |
| 获取半屏小程序调用列表 | /wxaapi/wxaembedded/get_list | 调用本接口可以获取半屏小程序调用列表 |
| 获取半屏小程序授权列表 | /wxaapi/wxaembedded/get_own_list | 调用本接口可以获取半屏小程序授权列表 |
| 设置授权方式 | /wxaapi/wxaembedded/set_authorize | 调用本接口可以设置半屏小程序授权方式 |
# 违规和申诉管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 获取小程序违规处罚记录 | /wxa/getillegalrecords | 调用本 API 可以获取小程序的违规处罚记录 |
| 获取小程序申诉记录 | /wxa/getappealrecords | 调用本 API 可以获取小程序的申诉记录 |
# 扫码关注公众号
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 获取已设置公众号信息 | /wxa/getshowwxaitem | 使用本接口可以获取扫码关注组件所展示的公众号信息 |
| 获取可设置公众号列表 | /wxa/getwxamplinkforshow | 通过本接口可以获取扫码关注组件允许展示的公众号列表 |
| 设置扫码关注的公众号 | /wxa/updateshowwxaitem | 使用本接口可以设置扫码关注组件所展示的公众号信息 |
# 扫普通二维码打开小程序
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 获取已设置的二维码规则 | /cgi-bin/wxopen/qrcodejumpget | 该接口用于获取已设置的二维码规则 |
| 增加或修改二维码规则 | /cgi-bin/wxopen/qrcodejumpadd | 该接口用于增加或修改二维码规则 |
| 发布已设置的二维码规则 | /cgi-bin/wxopen/qrcodejumppublish | 需要先调接口添加二维码规则,然后调用本接口将二维码规则发布生效,发布后用户扫码命中该规则的二维码时将跳转到正式版小程序指定的页面 |
| 删除已设置的二维码规则 | /cgi-bin/wxopen/qrcodejumpdelete | 该接口用于删除已设置的二维码规则 |
| 获取校验文件名称及内容 | /cgi-bin/wxopen/qrcodejumpdownload | 通过本接口下载随机校验文件,并将文件上传至服务器指定位置的目录下,方可通过所属权校验 |
# 小程序直播
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 申请开通直播 | /wxa/business/applyliveinfo | 通过该接口,第三方开发者可帮助商家发起小程序直播功能的申请 |
# 微信物流服务
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 申请开通物流消息 | /cgi-bin/express/delivery/open_msg/open_openmsg | 通过该接口,第三方开发者可帮助商家发起物流消息功能的申请 |
| 申请开通物流退货组件 | /cgi-bin/express/delivery/return/open_return | 通过该接口,第三方开发者可帮助商家发起物流退货组件的申请 |
| 申请开通物流查询组件 | /cgi-bin/express/delivery/open_msg/open_query_plugin | 通过该接口,第三方开发者可帮助商家发起物流查询组件的申请 |
# We分析
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 查询登录配置 | /wedata/wedata_get_login_config | 查询服务商登录配置 |
| 设置登录配置 | /wedata/wedata_set_login_config | 设置服务商登录配置 |
| 获取商家We分析权限集列表 | /wedata/wedata_get_perm_list | 获取当前商家的We分析权限集列表 |
| 设置用户We分析权限集 | /wedata/wedata_set_user_perm | 全量设置用户权限集 |
| 查询用户绑定列表 | /wedata/wedata_query_bind_list | 查询用户绑定列表 |
| 用户解绑 | /wedata/wedata_unbind_user | 用户解绑 |
| 用户PC端登录 | /wedata/wedata_login | 用户PC端登录 |
# 小程序流量主代运营
# 结算分成比例
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 设置默认分账比例 | /wxa/setdefaultamsinfo | 关于小程序流量主代运营的详细介绍以及使用步骤、常见问题等请查看小程序流量主代运营介绍,本文为小程序流量主代运营功能的接口文档 |
| 查询分账比例 | /wxa/getdefaultamsinfo | 该 API 用于查询服务商与小程序广告收入分账的比例 |
| 设置自定义分账比例 | /wxa/setdefaultamsinfo | 该 API 用于服务商针对单个小程序设置个性化的广告收入分账的比例 |
| 查询自定义分账比例 | /wxa/getdefaultamsinfo | 该 API 用于查询服务商针对单个小程序设置的个性化广告收入分账比例 |
# 开通流量主
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 检测是否能开通流量主 | /wxa/operationams | 该 API 用于服务商检测小程序是否达到开通流量主门槛 |
| 开通流量主 | /wxa/operationams | 该 API 用于为小程序开通流量主 |
# 广告位管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 创建广告单元 | /wxa/operationams | 该 API 用于为小程序创建广告单元 |
| 更新广告单元 | /wxa/operationams | 该 API 用于为小程序更新广告单元 |
| 获取原生模板广告模板类型 | /wxa/operationams | 该 API 用于查询原生模板广告模板类型 |
| 获取原生模板广告自定义模板绑定情况 | /wxa/operationams | 该 API 用于查询服务商自定义创建的原生模板绑定的广告单元列表 |
| 设置封面广告位开关状态 | /wxa/operationams | 该 API 用于设置小程序封面广告位开关状态 |
| 设置封面广告位场景值 | /wxa/operationams | 该 API 用于设置小程序封面广告位场景值 |
| 获取封面广告位状态 | /wxa/operationams | 该 API 用于查询小程序封面广告位状态 |
| 获取封面广告位场景设置 | /wxa/operationams | 该 API 用于查询小程序封面广告场景值 |
| 获取广告位或指定广告单元的信息 | /wxa/operationams | 该 API 用于查询广告位(除封面广告位)或指定广告单元的信息 |
| 获取广告单元代码 | /wxa/operationams | 该 API 用于查询广告单元代码 |
# 广告屏蔽
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 获取屏蔽的广告主 | /wxa/operationams | 该 API 用于查询当前小程序广告屏蔽的广告主 |
| 设置屏蔽的广告主 | /wxa/operationams | 该 API 用于设置小程序广告屏蔽的广告主 |
| 获取行业屏蔽信息 | /wxa/operationams | 该 API 用于查询小程序广告行业屏蔽信息 |
| 设置行业屏蔽信息 | /wxa/operationams | 该 API 用于设置小程序广告行业屏蔽信息 |
# 广告数据
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 获取小程序广告汇总数据 | /wxa/operationams | 该 API 用于获取小程序广告汇总数据 |
| 获取小程序广告细分数据 | /wxa/operationams | 该 API 用于获取小程序广告细分数据 |
| 获取服务商广告汇总数据 | /wxa/getdefaultamsinfo | 该 API 用于获取服务商通过流量主代运营模式产生的广告汇总数据 |
| 获取服务商广告明细数据 | /wxa/getdefaultamsinfo | 该 API 用于获取授权服务商进行流量主代运营,分小程序产生的广告细分数据,最小颗粒度为广告单元id(aduint) |
# 结算数据
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 获取小程序结算收入数据 | /wxa/operationams | 该 API 用于获取小程序结算收入数据 |
| 获取服务商结算收入数据 | /wxa/getdefaultamsinfo | 该 API 用于获取服务商结算收入数据 |
# 代商家管理公众号
# 公众号关联小程序
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 获取公众号关联的小程序 | /cgi-bin/wxopen/wxamplinkget | 该接口用于获取公众号关联的小程序 |
| 公众号关联小程序 | /cgi-bin/wxopen/wxamplink | 该接口用于关联小程序 |
| 公众号解除关联小程序 | /cgi-bin/wxopen/wxampunlink | 解除已关联的小程序 |
# 批量代云开发
# 环境管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 转换云环境 | /tcb/modifyenv | 通过本接口可以将腾讯云控制台创建的环境变更为微信小程序的环境 |
| 管理微信令牌权限 | /tcb/usecloudaccesstoken | 通过本接口可以开启或关闭cloudbaseaccesstoken的使用权限 |
| 查询环境共享信息 | /componenttcb/batchgetenvid | 通过本接口可以批量查询小程序被共享的环境id |
| 获取环境信息 | /componenttcb/describeenvs | 通过本接口可以获取环境列表 |
| 创建环境 | /componenttcb/createenv | 通过本接口可以创建环境 |
| 环境共享 | /componenttcb/batchshareenv | 通过本接口可以将环境共享给小程序(也称将小程序与环境绑定) |
| 解除环境共享关联关系 | /componenttcb/batchunshareenv | 通过本接口可以解除和对应小程序环境共享关联关系(也称将小程序解除环境绑定) |
# 云函数管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 创建云函数 | /componenttcb/batchuploadscf | 通过本接口可以批量创建云函数 |
| 更新云函数配置 | /componenttcb/updatescfconfig | 通过本接口可以更新云函数配置 |
| 删除云函数 | /componenttcb/deletescf | 通过本接口可以删除云函数 |
| 获取云函数 | /componenttcb/getscflist | 通过本接口可以获取云函数列表 |
| 获取触发器 | /componenttcb/gettriggers | 通过本接口可以获取触发器 |
| 更新触发器 | /componenttcb/batchupdatetriggers | 通过本接口可以批量更新触发器 |
| 触发云函数 | /tcb/invokecloudfunction | 通过本接口可以触发云函数 |
| 更新云函数代码 | /componenttcb/batchuploadscfcode | 通过本接口可以批量更新云函数代码 |
# 数据库管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 数据库导入 | /componenttcb/dbimport | 通过本接口可以数据库导入 |
| 数据库导出 | /componenttcb/dbexport | 通过本接口可以数据库导出 |
| 数据库状态查询 | /componenttcb/dbmigrationstate | 通过本接口可以数据库导入/导出状态查询 |
| 数据库聚合 | /componenttcb/dbaggregate | 通过本接口可以数据库聚合 |
| 获取数据库操作权限 | /componenttcb/dbgetacl | 通过本接口可以获取数据库操作权限 |
| 修改数据库操作权限 | /componenttcb/dbmodifyacl | 通过本接口可以修改数据库操作权限 |
| 数据库记录管理 | /componenttcb/dbrecord | 该接口可用于对数据库记录进行管理,包含插入记录、删除记录、更新记录、查询记录等功能 |
| 数据库索引管理 | /componenttcb/dbindex | 该接口用于创建索引和删除索引 |
# 存储管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 获取上传文件链接 | /componenttcb/uploadfile | 通过本接口可以获取上传文件链接 |
| 删除文件 | /componenttcb/batchdeletefile | 通过本接口可以删除文件 |
| 获取文件列表 | /componenttcb/getbucket | 通过本接口可以查看文件列表 |
| 获取下载文件链接 | /componenttcb/batchdownloadfile | 通过本接口可以获取下载文件链接 |
# 静态网页管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 查看静态网站状态 | /componenttcb/describestaticstore | 通过本接口可以查看静态网站状态 |
| 开通静态网站 | /componenttcb/createstaticstore | 通过本接口可以开通静态网站 |
| 获取上传静态网站文件链接 | /componenttcb/staticuploadfile | 通过本接口可以获取上传静态网站文件链接 |
| 获取静态网站文件列表 | /componenttcb/staticfilelist | 通过本接口可以配置获取静态网站文件列表 |
# 普通代云开发
# 开通与权限管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 管理微信令牌权限 | /tcb/usecloudaccesstoken | 通过本接口可以开启或关闭cloudbaseaccesstoken的使用权限 |
| 开通云开发 | /tcb/createclouduser | 通过本接口可以开通云开发 |
| 获取腾讯云API调用凭证 | /tcb/getqcloudtoken | 通过本接口可以获取腾讯云API调用凭证,腾讯云可用 API 概览 |
| 查询是否绑定手机号 | /tcb/checkmobile | 通过本接口可以查询小程序是否绑定了手机号,并支持推送模版消息给小程序管理员收集手机号 |
# 环境管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 转换云环境 | /tcb/modifyenv | 通过本接口可以将腾讯云控制台创建的环境变更为微信小程序的环境 |
| 创建云环境 | /tcb/createenvandresource | 通过本接口可以创建云环境 |
| 获取云环境 | /tcb/getenvinfo | 通过本接口可以获取已有的云环境信息 |
| 环境共享 | /tcb/shareenv | 通过本接口可以环境共享 |
# 消息推送
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 上传消息推送配置 | /tcb/setcallbackconfig | 通过本接口可以上传消息推送配置 |
| 获取消息推送配置 | /tcb/getcallbackconfig | 通过本接口可以获取消息推送配置 |
# 云函数管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 触发云函数 | /tcb/invokecloudfunction | 通过本接口可以触发云函数 |
| 创建云函数 | /tcb/createfunction | 通过本接口可以创建云函数 |
| 获取代码保护密钥 | /tcb/getcodesecret | 通过本接口可以获取代码保护密钥 |
| 获取上传凭证 | /tcb/getuploadsignature | 通过本接口可以获取上传云函数签名header |
| 获取云函数列表 | /tcb/listfunctions | 通过本接口可以获取云函数列表 |
| 获取云函数下载地址 | /tcb/downloadfunction | 通过本接口可以获取云函数下载地址 |
| 上传云函数配置 | /tcb/uploadfuncconfig | 通过本接口可以上传云函数配置 |
| 获取云函数配置 | /tcb/getfuncconfig | 通过本接口可以获取云函数配置 |
# 数据库管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 数据库集合管理 | /componenttcb/dbcollection | 数据库集合管理 |
| 获取集合信息 | /tcb/databasecollectionget | 通过本接口可以获取特定云环境下集合信息 |
| 新增集合 | /tcb/databasecollectionadd | 通过本接口可以新增集合 |
| 删除集合 | /tcb/databasecollectiondelete | 通过本接口可以删除集合 |
| 数据库聚合 | /tcb/databaseaggregate | 通过本接口可以数据库聚合 |
| 数据库导入 | /tcb/databasemigrateimport | 通过本接口可以进行数据库导入 |
| 数据库导出 | /tcb/databasemigrateexport | 通过本接口可以进行数据库导出 |
| 数据库迁移状态查询 | /tcb/databasemigratequeryinfo | 通过本接口可以数据库迁移状态查询 |
| 更新数据库索引 | /tcb/updateindex | 通过本接口可以变更数据库索引 |
| 统计集合记录数 | /tcb/databasecount | 通过本接口可以统计集合记录数或统计查询语句对应的结果记录数 |
| 数据库插入记录 | /tcb/databaseadd | 通过本接口可以数据库插入记录 |
| 数据库删除记录 | /tcb/databasedelete | 通过本接口可以数据库删除记录 |
| 数据库查询记录 | /tcb/databasequery | 通过本接口可以数据库查询记录 |
| 数据库更新记录 | /tcb/databaseupdate | 通过本接口可以数据库更新记录 |
# 文件管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 获取文件上传链接 | /tcb/uploadfile | 通过本接口可以获取文件上传链接 |
| 获取文件下载链接 | /tcb/batchdownloadfile | 通过本接口可以获取文件下载链接 |
| 删除文件 | /tcb/batchdeletefile | 通过本接口可以删除文件 |
# 微信支付
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 获取授权绑定的商户号列表 | /tcb/wxpaylist | 通过本接口可以查询授权绑定的商户号列表 |
| 申请商户号授权 | /tcb/wxpayopenauth | 通过本接口可以申请商户号授权 |
# 微信云托管
# 环境管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 查询环境共享信息 | /componenttcb/batchgetenvid | 通过本接口可以批量查询小程序被共享的环境id |
| 环境共享 | /componenttcb/batchshareenv | 通过本接口可以将环境共享给小程序(也称将小程序与环境绑定) |
| 解除环境共享关联关系 | /componenttcb/batchunshareenv | 通过本接口可以解除和对应小程序环境共享关联关系(也称将小程序解除环境绑定) |
| 获取环境信息 | /componenttcb/describecloudbaserunenvs | 通过本接口可以查询微信云托管环境信息 |
| 创建云托管环境 | /componenttcb/createcloudbaserunenv | 通过本接口可以创建微信云托管环境 |
# 服务管理
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 创建服务 | /componenttcb/establishcloudbaserunserver | 通过本接口可以创建云应用服务 |
| 创建服务版本 | /componenttcb/createcloudbaserunserverversion | 通过本接口可以创建服务版本 |
| 滚动更新服务版本 | /componenttcb/rollupdatecloudbaserunserverversion | 通过本接口可以滚动更新服务版本 |
| 删除服务版本 | /componenttcb/deletecloudbaserunserverversion | 通过本接口可以删除服务版本 |
| 发布服务 | /componenttcb/releasecloudbaserunversion | 通过本接口可以全量发布版本 |