小程序
取消
开发
中文
EN
取消
  • 服务端

    • # 接口调用凭证

    接口名称请求路径描述
    获取接口调用凭据/cgi-bin/token本接口用于获取获取全局唯一后台接口调用凭据（Access Token），token 有效期为 7200 秒，开发者需要进行妥善保存，使用注意事项请参考此文档
    获取稳定版接口调用凭据/cgi-bin/stable_token本接口用于获取获取全局唯一后台接口调用凭据（Access Token），token 有效期为 7200 秒，但此接口和 getAccessToken 互相隔离，

    # openApi管理

    接口名称请求路径描述
    查询API调用额度/cgi-bin/openapi/quota/get本接口用于查询服务端接口的的每日调用接口的额度，调用次数，频率限制
    重置API调用次数/cgi-bin/clear_quota本接口是通过access_token清空服务端接口的每日调用接口次数
    重置指定API调用次数/cgi-bin/openapi/quota/clear本接口使用 access_token 来重置指定接口的每日调用次数
    使用AppSecret重置API调用次数/cgi-bin/clear_quota/v2本接口是通过AppSecret清空服务端接口的每日调用接口次数
    查询rid信息/cgi-bin/openapi/rid/get本接口用于查询调用服务端接口报错返回的rid详情信息，辅助开发者高效定位问题
    网络通信检测/cgi-bin/callback/check为了帮助开发者排查回调连接失败的问题，提供这个网络检测的API
    获取微信API服务器IP/cgi-bin/get_api_domain_ip该接口用于获取微信 api 服务器 ip 地址（开发者服务器主动访问 api.weixin.qq.com 的远端地址）
    获取微信推送服务器IP/cgi-bin/getcallbackip该接口用于获取微信推送服务器 ip 地址（向开发者服务器推送信息的微信服务器来源地址）

    # 用户信息

    # 用户信息

    接口名称请求路径描述
    获取插件用户openpid/wxa/getpluginopenpid通过 wx.pluginLogin 接口获得插件用户标志凭证 code 后传到开发者服务器，开发者服务器调用此接口换取插件用户的唯一标识 openpid
    检查加密信息/wxa/business/checkencryptedmsg检查加密信息是否由微信生成（当前只支持手机号加密数据），只能检测最近3天生成的加密数据
    支付后获取Unionid/wxa/getpaidunionid该接口用于在用户支付完成后，获调用本接口前需要用户完成支付，用户支付完成后，取该用户的 UnionId，无需用户授权

    # 网络

    接口名称请求路径描述
    获取用户encryptKey/wxa/business/getuserencryptkey该接口用于获取用户encryptKey

    # 手机号

    接口名称请求路径描述
    获取手机号/wxa/business/getuserphonenumber该接口用于将code换取用户手机号

    # 小程序登录

    接口名称请求路径描述
    小程序登录凭证校验/sns/jscode2session登录凭证校验
    检验登录态/wxa/checksession校验服务器所保存的登录态 sessionkey 是否有效
    重置登录态/wxa/resetusersessionkey重置指定的登录态 sessionkey

    # 小程序码与小程序链接

    # 小程序码

    接口名称请求路径描述
    获取小程序码/wxa/getwxacode该接口用于获取小程序码，适用于需要的码数量较少的业务场景
    获取不限制的小程序码/wxa/getwxacodeunlimit该接口用于获取小程序码，适用于需要的码数量极多的业务场景
    获取小程序二维码/cgi-bin/wxaapp/createwxaqrcode获取小程序二维码，适用于需要的码数量较少的业务场景

    # URL Scheme

    接口名称请求路径描述
    查询scheme码/wxa/queryscheme该接口用于查询小程序 scheme 码，包括加密 scheme 和明文 scheme
    获取加密scheme码/wxa/generatescheme该接口用于获取小程序 scheme 码，适用于短信、邮件、外部网页、微信内等拉起小程序的业务场景
    获取NFC的小程序scheme/wxa/generatenfcscheme该接口用于获取用于 NFC 的小程序 scheme 码，适用于 NFC 拉起小程序的业务场景
    接口名称请求路径描述
    获取加密URLLink/wxa/generate_urllink获取小程序 URL Link，适用于短信、邮件、网页、微信内等拉起小程序的业务场景
    查询加密URLLink/wxa/query_urllink该接口用于查询小程序加密 url_link 配置
    接口名称请求路径描述
    获取ShortLink/wxa/genwxashortlink获取小程序 Short Link，适用于微信内拉起小程序的业务场景

    # 小程序客服

    # 客服消息

    接口名称请求路径描述
    获取临时素材/cgi-bin/media/get本接口用于获取临时素材（即下载临时的多媒体文件）
    客服输入状态/cgi-bin/message/custom/business/typing本接口用于设置客服输入状态
    新增临时素材/cgi-bin/media/upload本接口用于上传临时多媒体文件
    发送客服消息/cgi-bin/message/custom/send本接口用于发送多种类型的客服消息，主要应用在有人工消息处理环节的场景

    # 微信客服

    接口名称请求路径描述
    查询绑定情况/customservice/work/get查询小程序的微信客服绑定情况
    绑定微信客服/customservice/work/bind为小程序绑定微信客服
    解除绑定微信客服/customservice/work/unbind为小程序解除绑定微信客服

    # 消息相关

    # 动态消息

    接口名称请求路径描述
    创建activity_id/cgi-bin/message/wxopen/activityid/create该接口用于创建被分享动态消息或私密消息的 activity_id
    修改动态消息/cgi-bin/message/wxopen/updatablemsg/send该接口用于修改被分享的动态消息
    修改小程序聊天工具的动态卡片消息/cgi-bin/message/wxopen/chattoolmsg/send该接口用于修改被分享的小程序聊天工具的动态卡片消息

    # 订阅消息

    接口名称请求路径描述
    删除模板/wxaapi/newtmpl/deltemplate删除私有模板库中的模板
    获取类目/wxaapi/newtmpl/getcategory本接口用于获取小程序、公众号所属类目用于查询公共模板
    获取模板中的关键词/wxaapi/newtmpl/getpubtemplatekeywords该接口用于获取模板标题下的关键词列表
    获取类目下的公共模板/wxaapi/newtmpl/getpubtemplatetitles该接口用于获取帐号所属类目下的公共模板，可从中选用模板使用
    获取已有模板列表/wxaapi/newtmpl/gettemplate该接口用于获取当前帐号下的已有的模板列表
    发送订阅消息/cgi-bin/message/subscribe/send该接口用于发送订阅消息
    选用模板/wxaapi/newtmpl/addtemplate从公共模板库中选用模板到私有模板库
    激活与更新服务卡片/wxa/set_user_notify激活与更新服务卡片
    更新服务卡片扩展信息/wxa/set_user_notifyext更新服务卡片扩展信息
    查询服务卡片状态/wxa/get_user_notify查询服务卡片状态

    # 用工关系

    接口名称请求路径描述
    推送用工消息/cgi-bin/message/wxopen/employeerelationmsg/send向已绑定用工关系的用户通过小程序商家助手发送模版消息
    解绑用工关系/wxa/business/unbinduserb2cauthinfo批量解绑B2C模块已绑定的用工关系

    # 小程序安全

    # 内容安全

    接口名称请求路径描述
    文本内容安全识别/wxa/msg_sec_check该接口用于检查一段文本是否含有违法违规内容
    多媒体内容安全识别/wxa/media_check_async本接口用于异步校验图片/音频是否含有违法违规内容

    # 安全风控

    接口名称请求路径描述
    获取用户安全等级/wxa/getuserriskrank该接口用于根据提交的用户信息数据获取用户的安全等级 risk_rank（无需用户授权）

    # 数据分析

    # 访问留存

    接口名称请求路径描述
    获取用户访问小程序周留存/datacube/getweanalysisappidweeklyretaininfo该接口用于获取用户访问小程序周留存
    获取用户访问小程序月留存/datacube/getweanalysisappidmonthlyretaininfo该接口用于获取用户访问小程序月留存
    获取用户访问小程序日留存/datacube/getweanalysisappiddailyretaininfo该接口用于获取用户访问小程序日留存

    # 访问趋势

    接口名称请求路径描述
    获取用户访问小程序数据月趋势/datacube/getweanalysisappidmonthlyvisittrend该接口用于获取用户访问小程序数据月趋势(能查询到的最新数据为上一个自然月的数据)
    获取用户访问小程序数据日趋势/datacube/getweanalysisappiddailyvisittrend该接口用于获取用户访问小程序数据日趋势
    获取用户访问小程序数据周趋势/datacube/getweanalysisappidweeklyvisittrend该接口用于获取用户访问小程序数据周趋势

    # 其他

    接口名称请求路径描述
    获取用户访问小程序数据概况/datacube/getweanalysisappiddailysummarytrend该接口用于获取用户访问小程序数据概况
    获取访问页面数据/datacube/getweanalysisappidvisitpage该接口用于访问页面
    获取小程序用户画像分布/datacube/getweanalysisappiduserportrait该接口用于获取小程序新增或活跃用户的画像分布数据
    获取小程序性能数据/wxa/business/performance/boot该接口用于获取小程序启动性能，运行性能等数据
    获取用户小程序访问分布数据/datacube/getweanalysisappidvisitdistribution该接口用于获取用户小程序访问分布数据

    # 硬件设备

    接口名称请求路径描述
    发送设备消息/cgi-bin/message/device/subscribe/send通过该接口向用户发送设备消息
    获取设备票据/wxa/getsnticket通过该接口可获取设备票据，5 分钟内有效
    创建设备组/wxa/business/group/createid本接口用于创建设备组，便于用户一次性订阅多个设备
    查询设备组信息/wxa/business/group/getinfo本接口用于查询设备组的信息
    设备组添加设备/wxa/business/group/adddevice本接口用于为设备组添加设备
    设备组删除设备/wxa/business/group/removedevice本接口为设备组删除已添加的设备
    查询license资源包列表/wxa/business/license/getpkglist查询小程序已购买的 license 资源包列表信息
    激活设备license/wxa/business/license/activedevice该接口用于批量绑定设备，并消耗相应的资源包中的激活码序号
    查询设备激活详情/wxa/business/license/getdeviceinfo该接口用于批量查询设备剩余有效期

    # 运维中心

    接口名称请求路径描述
    查询域名配置/wxa/getwxadevinfo该接口用于查询小程序域名配置信息
    获取性能数据/wxaapi/log/get_performance该接口用于获取性能数据
    获取访问来源/wxaapi/log/get_scene该接口用于获取访问来源
    获取客户端版本/wxaapi/log/get_client_version该接口用于获取客户端版本
    查询实时日志/wxaapi/userlog/userlog_search该接口用于查询实时日志
    获取用户反馈列表/wxaapi/feedback/list该接口用于获取用户反馈列表
    获取mediaId图片/cgi-bin/media/getfeedbackmedia该接口用于获取 mediaId 图片
    查询js错误详情/wxaapi/log/jserr_detail该接口用于查询JS错误详情
    查询错误列表/wxaapi/log/jserr_list本接口用于查询错误列表
    获取分阶段发布详情/wxa/getgrayreleaseplan该接口用于查询当前分阶段发布详情

    # 插件管理

    接口名称请求路径描述
    插件申请管理/wxa/devplugin该接口供插件开发者调用，用于获取当前所有插件使用方信息以及修改插件使用申请的状态
    插件管理/wxa/plugin该接口用于管理插件，支持申请、查看、更新、删除插件等操作

    # 云开发

    # 云函数

    接口名称请求路径描述
    触发云函数/tcb/invokecloudfunction通过本接口可以触发云函数

    # 数据库

    接口名称请求路径描述
    数据库插入记录/tcb/databaseadd通过本接口可以数据库插入记录
    数据库聚合/tcb/databaseaggregate通过本接口可以数据库聚合
    新增集合/tcb/databasecollectionadd通过本接口可以新增集合
    删除集合/tcb/databasecollectiondelete通过本接口可以删除集合
    获取集合信息/tcb/databasecollectionget通过本接口可以获取特定云环境下集合信息
    统计集合记录数/tcb/databasecount通过本接口可以统计集合记录数或统计查询语句对应的结果记录数
    数据库删除记录/tcb/databasedelete通过本接口可以数据库删除记录
    数据库导出/tcb/databasemigrateexport通过本接口可以进行数据库导出
    数据库导入/tcb/databasemigrateimport通过本接口可以进行数据库导入
    数据库迁移状态查询/tcb/databasemigratequeryinfo通过本接口可以数据库迁移状态查询
    数据库查询记录/tcb/databasequery通过本接口可以数据库查询记录
    数据库更新记录/tcb/databaseupdate通过本接口可以数据库更新记录
    更新数据库索引/tcb/updateindex通过本接口可以变更数据库索引

    # 存储

    接口名称请求路径描述
    获取文件上传链接/tcb/uploadfile通过本接口可以获取文件上传链接
    获取文件下载链接/tcb/batchdownloadfile通过本接口可以获取文件下载链接
    删除文件/tcb/batchdeletefile通过本接口可以删除文件

    # 其他

    接口名称请求路径描述
    发送短信v2/tcb/sendsmsv2发送携带 URL Link 的短信
    发送短信/tcb/sendsms发送支持打开云开发静态网站的短信，该 H5 可以打开小程序
    创建发短信任务/tcb/createsendsmstask该接口用于创建发短信任务
    云开发上报接口/tcb/cloudbasereport该接口为云开发通用上报接口
    查询短信记录/tcb/describesmsrecords该接口用于查询 2 个月内的短信记录
    描述扩展上传文件信息/tcb/describeextensionuploadinfo该接口用于描述扩展上传文件信息
    获取云开发数据/tcb/getstatistics该接口用于获取云开发数据
    获取cloudID对应的数据/wxa/getopendata该接口用于换取 cloudID 对应的开放数据
    获取实时语音签名/wxa/getvoipsign该接口用于获取实时语音签名
    获取腾讯云API调用凭证/tcb/getqcloudtoken通过本接口可以获取腾讯云API调用凭证,腾讯云可用 API 概览

    # 物流助手

    # 小程序使用

    接口名称请求路径描述
    绑定/解绑物流账号/cgi-bin/express/business/account/bind该接口用于绑定、解绑物流账号
    获取所有绑定的物流账号/cgi-bin/express/business/account/getall该接口用于获取所有绑定的物流账号
    获取支持的快递公司列表/cgi-bin/express/business/delivery/getall该接口用于获取支持的快递公司列表
    取消运单/cgi-bin/express/business/order/cancel该接口用于取消运单
    配置面单打印员/cgi-bin/express/business/printer/update该接口用于配置面单打印员，可以设置多个，若需要使用微信打单 PC 软件，才需要调用
    获取电子面单余额/cgi-bin/express/business/quota/get该接口用于获取电子面单余额
    获取运单数据/cgi-bin/express/business/order/get该接口用于获取运单数据
    模拟更新订单状态/cgi-bin/express/business/test_update_order该接口用于模拟快递公司更新订单状态, 该接口只能用户测试
    获取打印员/cgi-bin/express/business/printer/getall该接口用于获取打印员
    查询运单轨迹/cgi-bin/express/business/path/get该接口用于查询运单轨迹
    批量获取运单数据/cgi-bin/express/business/order/batchget该接口用于批量获取运单数据
    生成运单/cgi-bin/express/business/order/add该接口用于生成运单

    # 运力方使用

    接口名称请求路径描述
    更新商户审核结果/cgi-bin/express/delivery/service/business/update该接口用于更新商户审核结果
    更新运单轨迹/cgi-bin/express/delivery/path/update该接口用于更新运单轨迹
    预览面单模板/cgi-bin/express/delivery/template/preview该接口用于预览面单模板
    获取面单联系人信息/cgi-bin/express/delivery/contact/get该接口用于获取面单联系人信息

    # 即时配送

    # 小程序使用

    接口名称请求路径描述
    获取已支持的配送公司列表/cgi-bin/express/local/business/delivery/getall该接口用于获取已支持的配送公司列表
    预下配送单/cgi-bin/express/local/business/order/pre_add使用场景描述
    拉取已绑定账号/cgi-bin/express/local/business/shop/get商家可通过本接口查询自己已经在小程序后台绑定的和配送公司签约的账号； 服务商可通过本接口查询代开发的小程序在小程序后台绑定的和配送公司签约的账号，为其完成后续的
    预取消配送单/cgi-bin/express/local/business/order/precancel使用场景描述
    申请开通即时配送/cgi-bin/express/local/business/open该接口用于第三方代商户发起开通即时配送权限
    发起绑定请求/cgi-bin/express/local/business/shop/add该接口用于第三方代商户发起绑定配送公司帐号的请求
    重新下单/cgi-bin/express/local/business/order/readd在调用下配送单接口、订单被取消、过期或者投递异常的情况下，可调用此接口，重新下单，需要保持orderid一致
    模拟更新配送单状态/cgi-bin/express/local/business/realmock_update_order该接口用于模拟配送公司更新配送单状态，可进行测试账户下的单，将请求转发到运力测试环境
    模拟配送公司更新配送单状态/cgi-bin/express/local/business/test_update_order该接口用于模拟配送公司更新配送单状态, 该接口只用于沙盒环境，即订单并没有真实流转到运力方.
    拉取配送单信息/cgi-bin/express/local/business/order/get商家可使用本接口查询某一配送单的配送状态，便于商家掌握配送情况
    异常件退回商家确认/cgi-bin/express/local/business/order/confirm_return该接口用于异常件退回商家后商家确认收货
    取消配送单/cgi-bin/express/local/business/order/cancel该接口用于取消配送单
    添加小费/cgi-bin/express/local/business/order/addtips该接口可以对待接单状态的订单增加小费
    添加配送单/cgi-bin/express/local/business/order/add该接口用于下配送单

    # 运力方使用

    接口名称请求路径描述
    更新配送单状态/cgi-bin/express/local/delivery/update_order该接口用于配送公司更新配送单状态

    # 小程序交易管理服务

    接口名称请求路径描述
    品牌申请/wxa/sec/famousbrand/apply本接口用于小程序品牌申请
    小程序品牌申请状态查询/wxa/sec/famousbrand/get_status本接口用于查询小程序品牌申请状态

    # 交易保障

    # 基础能力

    接口名称请求路径描述
    获取小程序交易体验分违规记录/wxaapi/wxamptrade/get_penalty_list获取小程序交易体验分违规记录
    获取交易保障标状态/wxaapi/wxamptrade/get_guarantee_status获取交易保障标状态

    # 附近小程序

    接口名称请求路径描述
    添加地点/wxa/addnearbypoi该接口用于添加附近小程序的地点
    删除地点/wxa/delnearbypoi该接口用于删除附近小程序的地点
    查看地点/wxa/getnearbypoilist该接口用于查看附近小程序的地点列表
    设置展示状态/wxa/setnearbypoishowstatus该接口用于展示/取消展示附近小程序

    # 小程序直播

    # 直播间管理

    接口名称请求路径描述
    创建直播间/wxaapi/broadcast/room/create调用此接口创建直播间，创建成功后将在直播间列表展示
    获取直播间列表和回放/wxa/business/getliveinfo该接口用于获取直播间列表及直播间信息
    删除直播间/wxaapi/broadcast/room/deleteroom该接口用于删除直播间
    导入商品/wxaapi/broadcast/room/addgoods该接口用于往指定直播间导入商品
    编辑直播间/wxaapi/broadcast/room/editroom该接口用于编辑直播间
    获取直播间推流地址/wxaapi/broadcast/room/getpushurl该接口用于获取直播间推流地址
    获取直播间分享二维码/wxaapi/broadcast/room/getsharedcode该接口用于获取直播间分享二维码
    获取主播副号/wxaapi/broadcast/room/getsubanchor该接口用于获取主播副号
    修改主播副号/wxaapi/broadcast/room/modifysubanchor该接口用于修改主播副号
    删除主播副号/wxaapi/broadcast/room/deletesubanchor该接口用于删除主播副号
    添加主播副号/wxaapi/broadcast/room/addsubanchor该接口用于点击直播副号
    删除直播间商品/wxaapi/broadcast/goods/deleteInRoom该接口用于删除直播间商品
    推送商品/wxaapi/broadcast/goods/push该接口用于推送商品到直播间
    上下架商品/wxaapi/broadcast/goods/onsale该接口用于下架或者上架商品
    直播间商品排序/wxaapi/broadcast/goods/sort该接口用于直播间商品排序
    修改直播间小助手/wxaapi/broadcast/room/modifyassistant该接口用于修改直播间小助手
    查询直播间小助手/wxaapi/broadcast/room/getassistantlist该接口用于查询直播间小助手
    删除直播间小助手/wxaapi/broadcast/room/removeassistant该接口用于删除直播间小助手
    添加管理直播间小助手/wxaapi/broadcast/room/addassistant该接口用于添加管理直播间小助手
    禁言管理/wxaapi/broadcast/room/updatecomment该接口用于开启/关闭直播间全局禁言
    官方收录管理/wxaapi/broadcast/room/updatefeedpublic该接口用于开启/关闭直播间官方收录
    客服功能管理/wxaapi/broadcast/room/updatekf该接口用于开启/关闭客服功能
    回放功能管理/wxaapi/broadcast/room/updatereplay该接口用于开启/关闭回放功能
    下载商品讲解视频/wxaapi/broadcast/goods/getVideo该接口用于下载商品讲解视频

    # 商品管理

    接口名称请求路径描述
    添加并提审商品/wxaapi/broadcast/goods/add调用此接口上传并提审需要直播的商品信息，审核通过后商品录入【小程序直播】商品库
    重新提交商品审核/wxaapi/broadcast/goods/audit调用此接口可以对已撤回提审的商品再次发起提审申请
    获取商品的信息与审核状态/wxa/business/getgoodswarehouse该接口用于获取商品的信息与审核状态
    撤回商品审核/wxaapi/broadcast/goods/resetaudit该接口用于撤回商品审核，消耗的提审次数不返还
    更新商品/wxaapi/broadcast/goods/update调用此接口可以更新商品信息，审核通过的商品仅允许更新价格类型与价格，审核中的商品不允许更新，未审核的商品允许更新所有字段， 只传入需要更新的字段
    获取商品列表/wxaapi/broadcast/goods/getapproved该接口用户获取不同审核状态的商品信息
    删除商品/wxaapi/broadcast/goods/delete调用此接口，可删除【小程序直播】商品库中的商品，删除后直播间上架的该商品也将被同步删除，不可恢复；

    # 成员管理

    接口名称请求路径描述
    设置成员角色/wxaapi/broadcast/role/addrole调用此接口设置小程序直播成员的管理员、运营者和主播角色
    移除成员角色/wxaapi/broadcast/role/deleterole调用此接口可移除小程序直播成员的管理员、运营者和主播角色
    查询成员列表/wxaapi/broadcast/role/getrolelist该接口用于查询小程序直播成员列表

    # 长期订阅

    接口名称请求路径描述
    发送直播开始事件/wxa/business/push_message该接口用于向长期订阅用户群发直播间开始事件
    获取长期订阅用户/wxa/business/get_wxa_followers该接口用于获取长期订阅用户列表

    # 图像处理与文字识别

    # 图像处理

    接口名称请求路径描述
    图片智能裁剪/cv/img/aicrop本接口用于对图片主体区域进行智能识别和裁剪
    二维码/条码识别/cv/img/qrcode识别图片中的二维码、条码、DataMatrix和PDF417
    图片高清化/cv/img/superresolution该接口用于将图片高清化，由于系统维护原因，已下架，如有需要使用，可前往微信开放社区发帖/联系微信服务市场客服

    # OCR

    接口名称请求路径描述
    通用印刷体识别/cv/ocr/comm本接口用于识别通用印刷体
    行驶证识别/cv/ocr/driving提供机动车行驶证信息OCR识别
    银行卡识别/cv/ocr/bankcard本接口提供银行卡卡面信息OCR识别
    营业执照识别/cv/ocr/bizlicense本接口提供营业执照 OCR 识别能力
    驾驶证识别/cv/ocr/drivinglicense本接口用于驾驶证识别
    身份证识别/cv/ocr/idcard本接口提供身份证正反面OCR识别功能

    # 微信红包封面

    接口名称请求路径描述
    获取微信红包封面/redpacketcover/wxapp/cover_url/get_by_token本接口用于获得指定用户可以领取的红包封面链接

    # 微信服务市场

    接口名称请求路径描述
    调用服务市场接口/wxa/servicemarket该接口用于调用服务平台提供的api服务

    # 生物认证

    接口名称请求路径描述
    生物认证秘钥签名验证/cgi-bin/soter/verify_signature该接口用于SOTER 生物认证秘钥签名验证