微信JS接口汇总及使用详解

基本说明

使用说明

1.引入JS文件

在需要调用JS接口的页面引入如下JS文件，（支持https）：

备注：支持使用 AMD/CMD 标准模块加载方法加载

2.注入配置config接口

所有需要使用JSSDK的页面必须先注入配置信息，否则将无法调用（同一个url仅需调用一次，对于变化url的SPA的web app可在每次url变化时进行调用）。

fig({ debug: true,// 开启调试模式,调用的所有api的返回值会在客户端alert出来，若要查看传入的参数，可以在pc端打开，参数信息会通过log打出，仅在pc端时才会打印。 appId: '',// 必填，公众号的唯一标识 timestamp:,// 必填，生成签名的时间戳 nonceStr: '',// 必填，生成签名的随机串 signature: '',// 必填，签名，见附录1 jsApiList: [] // 必填，需要使用的JS接口列表，所有JS接口列表见附录2 });

3.验证通过ready接口

代码如下:

// config信息验证后会执行ready方法，所有接口调用都必须在config接口获得结果之后，config是一个客户端的异步操作，所以如果需要在页面加载时就调用相关接口，则须把相关接口放在ready函数中调用来确保正确执行。对于用户触发时才调用的接口，则可以直接调用，不需要放在ready函数中。 });

4.验证失败error接口

代码如下:

fig信息验证失败会执行error函数，如签名过期导致验证失败，具体错误信息可以打开config的debug模式查看，也可以在返回的res参数中查看，对于SPA可以在这里更新签名。 });

接口调用说明

所有接口通过wx对象(也可使用jWeixin对象)来调用，参数是一个对象，除了每个接口本身需要传的参数之外，还有以下通用参数：

success：接口调用成功时执行的回调函数。 fail：接口调用失败时执行的回调函数。 complete：接口调用完成时执行的回调函数，无论成功或失败都会执行。 cancel：用户点击取消时的回调函数，仅部分有用户取消操作的api才会用到。 trigger: 监听Menu中的按钮点击时触发的方法，该方法仅支持Menu中的相关接口。

以上几个函数都带有一个参数，类型为对象，其中除了每个接口本身返回的数据之外，还有一个通用属性errMsg，其值格式如下：

调用成功时："xxx:ok" ，其中xxx为调用的接口名用户取消时："xxx:cancel"，其中xxx为调用的接口名调用失败时：其值为具体错误信息

基础接口

判断当前客户端版本是否支持指定JS接口

代码如下:

});

分享接口

获取“分享到朋友圈”按钮点击状态及自定义分享内容接口

代码如下:

分享标题 link: '',// 分享链接 imgurl: '',// 分享图标 success: function () { // 用户确认分享后执行的回调函数 }, cancel: function () { // 用户取消分享后执行的回调函数 } });

获取“分享给朋友”按钮点击状态及自定义分享内容接口

代码如下:

分享标题 desc: '',// 分享描述 link: '',// 分享链接 imgurl: '',// 分享图标 type: '',// 分享类型,music、video或link，不填默认为link dataUrl: '',// 如果type是music或video，则要提供数据链接，默认为空 success: function () { // 用户确认分享后执行的回调函数 }, cancel: function () { // 用户取消分享后执行的回调函数 } });

获取“分享到QQ”按钮点击状态及自定义分享内容接口

代码如下:

分享链接 imgurl: '' // 分享图标 success: function () { // 用户确认分享后执行的回调函数 }, cancel: function () { // 用户取消分享后执行的回调函数 } });

获取“分享到腾讯微博”按钮点击状态及自定义分享内容接口

代码如下:

用户取消分享后执行的回调函数 } });

图像接口

拍照或从手机相册中选图接口

代码如下:

img标签的src属性显示图片 } });

预览图片接口

代码如下:

显示的图片链接 urls: [] // 需要预览的图片链接列表 });

上传图片接口

代码如下:

上传的图片的本地ID，由chooseImage接口获得 isShowProgresstips: 1// 默认为1，显示进度提示 success: function (res) { var serverId = res.serverId; // 返回图片的服务器端ID } });

备注：可用微信下载多媒体文件接口下载上传的图片，此处获得的 serverId 即 media_id，参考文档../12/58bfcfabbd501c7cd77c19bd9cfa8354.html

下载图片接口

代码如下:

图片的服务器端ID，由uploadImage接口获得 isShowProgresstips: 1// 默认为1，显示进度提示 success: function (res) { var localId = res.localId; // 返回图片下载后的本地ID } });

音频接口

开始录音接口

代码如下:

停止录音接口

代码如下:

监听录音自动停止接口

代码如下:

播放语音接口

代码如下:

暂停播放接口

代码如下:

停止播放接口

代码如下:

监听语音播放完毕接口

代码如下:

上传语音接口

代码如下:

上传的音频的本地ID，由stopRecord接口获得 isShowProgresstips: 1// 默认为1，显示进度提示 success: function (res) { var serverId = res.serverId; // 返回音频的服务器端ID } });

备注：可用微信下载多媒体文件接口下载上传的语音，此处获得的 serverId 即 media_id，参考文档../12/58bfcfabbd501c7cd77c19bd9cfa8354.html

下载语音接口

代码如下:

sstips: 1// 默认为1，显示进度提示 success: function (res) { var localId = res.localId; // 返回音频的本地ID } });

智能接口

识别音频并返回识别结果接口

代码如下:

sstips: 1,// 默认为1，显示进度提示 success: function (res) { alert(res.translateResult); // 语音识别的结果 } });

设备信息

获取网络状态接口

代码如下:

地理位置

使用微信内置地图查看位置接口

代码如下:

默认为最大 infoUrl: '' // 在查看位置界面底部显示的超链接,可点击跳转 });

获取地理位置接口

代码如下:

随机串，仅当需要兼容6.0.2版本之前时提供
 addrSign: '',// 位置签名，仅当需要兼容6.0.2版本之前时提供，详见附录4
 success: function (res) {
 var longitude = res.longitude; // 纬度，浮点数，范围为90 ~ -90
 var latitude = res.latitude; // 经度，浮点数，范围为180 ~ -180。
 var speed = res.speed; // 速度，以米/每秒计
 var accuracy = res.accuracy; // 位置精度
 }
});

界面操作

代码如下:

菜单接口 wx.hideOptionMenu(); 显示右上角菜单接口 wx.showOptionMenu(); 关闭当前网页窗口接口 wx.closeWindow(); 批量隐藏功能按钮接口 wx.hideMenuItems({ menuList: [] // 要隐藏的菜单项，所有menu项见附录3 }); 批量显示功能按钮接口 wx.showMenuItems({ menuList: [] // 要显示的菜单项，所有menu项见附录3 }); 隐藏所有非基础按钮接口 wx.hideAllNonBaseMenuItem(); 显示所有功能按钮接口 wx.showAllNonBaseMenuItem(); 微信扫一扫调起微信扫一扫接口 wx.scanQRCode({ desc: 'scanQRCode desc', needResult: 0,// 默认为0，扫描结果由微信处理，1则直接返回扫描结果， scanType: ["qrCode","barCode"],// 可以指定扫二维码还是一维码，默认二者都有 success: function () { var result = res.resultStr; // 当needResult 为 1 时，扫码返回的结果 } });

收获地址

编辑收货地址接口

代码如下:

获取最近的收货地址接口

代码如下:

微信小店

跳转微信商品页接口

代码如下:

默认值，普通商品详情页1.扫一扫商品详情页2.小店商品详情页
});

微信卡券

调起适用于门店的卡券列表并获取用户选择列表

代码如下:

随机串 cardSign: '',// 卡券签名，详见附录6 success: function (res) { var cardList= res.cardList; // 用户选中的卡券列表信息 } });

批量添加卡券接口

代码如下:

添加的卡券列表 success: function (res) { var cardList = res.cardList; // 添加的卡券列表信息 } });

查看微信卡包中的卡券接口

代码如下:

微信支付

发起一个微信支付请求

代码如下:

随机串
package: '',// 订单详情扩展字符串，详见附录5
paySign: '',// 支付签名，详见附录5
});

原文地址：https://www.jb51.cc/js/56411.html

JS接口微信微信微信

上一篇：PHP配置文件php.ini中打开错误报告下一篇：JavaScript Math.floor方法(对数值

相关推荐

自定义web弹窗/层：简易风格的msg与可拖放的dialog，生成博客园文章目录弹窗

前言做过web项目开发的人对layer弹层组件肯定不陌生，作为layUI的一个重要组件，使用简单、接口参数丰富，功能健壮，深受广大开发者的喜爱，作为一个热（经）爱（常）工（划）作（水），喜欢钻研探索技术的程序员（狗），我们自己来实现一个web弹窗/层，一窥layer的本源（/手动滑稽脸），进步，从

作者：huanzi-qch 时间：2024-09-25

nice-validator表单验证插件的简单使用

前言前端表单校验是过滤无效数据、假数据、有毒数据的第一步，是数据安全的第一道关卡，虽然我们不能100%相信客户端提交的数据（真正的校验还得在服务端进行），但设置前端表单校验也是至关重要的，自己写逻辑代码一个一个表单字段去校验不现实，又不想自己造轮子，使用jquery插件是不错的选择，这里记录一下在

作者：huanzi-qch 时间：2024-09-25

基于“formData批量上传的多种实现” 的多图片预览、上传的多种实现

前言图片上传是web项目常见的需求，我基于之前的博客的代码（请戳：formData批量上传的多种实现）里的第三种方法实现多图片的预览、上传，并且支持三种方式添加图片到上传列表：选择图片、复制粘贴图片、鼠标拖拽图片，同时支持从上传列表中移除图片（点击“X”号）效果演示选择图片页面操作后台接参

作者：huanzi-qch 时间：2024-09-25

踹掉后端，前端导出Excel！

前言导出Excel文件这个功能，通常都是在后端实现返回前端一个下载链接，但有时候我们只想导出前端页面上已经有了的数据，不想再调后端导出接口浪费服务器资源，学习本文demo例子，我们踹掉后端，直接在前端导出Excel！代码实现 1、利用Blob对象构造一个a标签的href链接，从而实现文件下载，E

作者：huanzi-qch 时间：2024-09-25

Web Worker——js的多线程，实现统计博客园总阅读量、总评论量、总推荐量

前言众所周知，js是单线程的，从上往下，从左往右依次执行，当我们有耗时的任务需要处理时，便会阻塞线程造成页面卡顿等问题。web worker的目的，就是为JavaScript创造多线程环境，允许主线程将一些任务分配给子线程。在主线程运行的同时，子线程在后台运行，两者互不干扰。等到子线程完成计算任务

作者：huanzi-qch 时间：2024-09-25

select标签禁止选择但又能通过序列化form表单传值到后台

前言项目开发中，我们可能会碰到这样的需求：select标签，禁止选择但又能通过序列化form表单传值到后台，但是当我们使用disabled="disabled"时发现，无法序列化form获取到select标签的值；当我们使用readonly="readonly&quo

作者：huanzi-qch 时间：2024-09-25

还在问跨域？本文记录js跨域的多种实现实例

前言众所周知，受浏览器同源策略的影响，产生了跨域问题，那么我们应该如何实现跨域呢？本文记录几种跨域的简单实现前期准备为了方便测试，我们启动两个服务，10086（就是在这篇博客自动生成的项目，请戳：SpringBoot系列——Spring-Data-JPA（究极进化版）自动生成单表基础增、删、

作者：huanzi-qch 时间：2024-09-25

formData批量上传的多种实现

前言最近项目需要批量上传附件，查了下资料，网上很多但看着一脸懵，只贴部分代码，介绍也不详细，这里记录一下自己的采坑与多种实现，以免以后忘记。这里先介绍下FormData对象，以下内容摘自：https://developer.mozilla.org/zh-CN/docs/Web/API/FormD

作者：huanzi-qch 时间：2024-09-25

laypage 物理分页与逻辑分页实例

前言以下介绍摘自 layui官网laypage layPage 致力于提供极致的分页逻辑，既可轻松胜任异步分页，也可作为页面刷新式分页。自 layui 2.0 开始，无论是从核心代码还是API设计，layPage 都完成了一次蜕变。清爽的UI、灵活的排版，极简的调用方式，这一切的优质元素

作者：huanzi-qch 时间：2024-09-25

乐观锁机制解决多层嵌套异步ajax问题

前言在项目中我们通常需要使用ajax异步嵌套去请求数据并做数据的展示，当我们多次快速的多次的发起ajax，因为ajax是异步的，每个ajax触发回调的时间都是不可控的，这样就会造成前面发起的ajax跟后面发起的ajax都有可能去修改同一个DOM，导致展示的数据顺序错乱或数据重复，我们希望DOM展示

作者：huanzi-qch 时间：2024-09-25

小编推荐

苹果市值2025年有望达4万亿美元