微信JS-SDK调用微信接口方法说明

最新推荐文章于 2025-03-27 16:42:40 发布

原创最新推荐文章于 2025-03-27 16:42:40 发布 · 9.1k 阅读

9 ·

CC 4.0 BY-SA版权

文章标签：

#微信 #JS-SDK #微信JSSDK #微信扫一扫 #微信上传图片

HTML5 同时被 2 个专栏收录

5 篇文章

订阅专栏

微信开发

4 篇文章

订阅专栏

微信公众平台微信JS-SDK说明文档地址：https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421141115

概述

微信JS-SDK是微信公众平台面向网页开发者提供的基于微信内的网页开发工具包。

通过使用微信JS-SDK，网页开发者可借助微信高效地使用拍照、选图、语音、位置等手机系统的能力，同时可以直接使用微信分享、扫一扫、卡券、支付等微信特有的能力，为微信用户提供更优质的网页体验。

这里主要记录调用微信扫一扫、拍照或从手机相册中选图、上传图片的接口，其他接口调用方法类似，只是传递参数不同。

步骤一：绑定域名

先登录微信公众平台进入“公众号设置”的“功能设置”里填写“JS接口安全域名”。

备注：登录后可在“开发者中心”查看对应的接口权限。

步骤二：引入JS文件

在需要调用JS接口的页面引入如下JS文件，（支持https）：http://res.wx.qq.com/open/js/jweixin-1.2.0.js

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

也可以将jweixin-1.2.0.js文件下载到本地引入，下载地址：（http://www.veryhuo.com/down/html/161052.html#download_area）

步骤三：通过config接口注入权限验证配置

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

wx.config({

    debug: true, // 开启调试模式,调用的所有api的返回值会在客户端alert出来，若要查看传入的参数，可以在pc端打开，参数信息会通过log打出，仅在pc端时才会打印。

    appId: '', // 必填，公众号的唯一标识

    timestamp: , // 必填，生成签名的时间戳

    nonceStr: '', // 必填，生成签名的随机串

    signature: '',// 必填，签名，见附录1

    jsApiList: [] // 必填，需要使用的JS接口列表，所有JS接口列表见附录2

});

上面的参数需要后台写一个接口获取:，如

var url = window.location.href;
$.ajax({
    url: url_bjtest + "/wechat/get_signature",
    type: "post",
    data: { "url" : url },
    dataType: "json",
    success: function (data) {
        wx.config({
            appId: data.data.appId,
            timestamp: data.data.timestamp,
            nonceStr: data.data.nonceStr,
            signature: data.data.signature,
            jsApiList: ['scanQRCode','chooseImage','uploadImage']
        });
    }
});

步骤四：处理验证结果

如果调用微信接口的代码放在事件处理函数中，则可以不用进行此步骤，否则必须放在如下ready方法内。

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

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

});

步骤五：调用接口

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

1.success：接口调用成功时执行的回调函数。

2.fail：接口调用失败时执行的回调函数。

3.complete：接口调用完成时执行的回调函数，无论成功或失败都会执行。

4.cancel：用户点击取消时的回调函数，仅部分有用户取消操作的api才会用到。

5.trigger: 监听Menu中的按钮点击时触发的方法，该方法仅支持Menu中的相关接口。

注意：所有接口调用都必须在config接口获得结果之后，放在wx.ready(function(){…})函数中调用来确保正确执行；

或者放在DOM元素的事件处理函数中调用来确保正确执行。

1、基础接口

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

wx.checkJsApi({

    jsApiList: ['chooseImage'], // 需要检测的JS接口列表

    success: function(res) {

        // 以键值对的形式返回，可用的api值true，不可用为false
        // 如：{"checkResult":{"chooseImage":true},"errMsg":"checkJsApi:ok"}

    }

});

2、扫一扫接口

wx.ready(function(){
    wx.scanQRCode({
        needResult: 1, // 默认为0，扫描结果由微信处理，1则直接返回扫描结果，  
        scanType: ["qrCode", "barCode"], // 可以指定扫二维码还是一维码，默认二者都有  
        success: function (res) {
            var result = res.resultStr; // 当needResult 设置为 1 时，扫码返回的结果
            //（result 就是一个带有sid的网址）
        }
    })
});

3、调用拍照或从手机相册中选图接口

这里获取到的是用户选择的图片的本地地址列表（res.localIds）

<button type="button" id="addImg">上传图片</button>
var imgFiles = [];
$("#addImg").on("click",function(){
    wx.chooseImage({
        success: function(res) {
            //res.localIds为返回的选定照片的本地ID列表（即存储本地图片路径字符串的数组）
            imgFiles = imgFiles.concat(res.localIds);
        }
    });
});

4、调用上传图片接口

这里获取到的是用户选择图片后上传到微信服务器的服务器端地址（res.serverId）

var serverIds = [];   //要传到服务器的图片列表serverId
var i = 0, length = imgFiles.length;
function upload() {
    wx.uploadImage({
        localId: imgFiles[i],
        isShowProgressTips: 0,
        success: function(res) {
            i++;
            //alert('已上传：' + i + '/' + length);
            serverIds.push(res.serverId);
            if (i < length) {
                upload();
            }
        },
        fail: function(res) {
            alert(JSON.stringify(res));
        }
    });
}
upload();   //通过imgFiles本地Id，上传图片到微信服务器，并获取serverId，便于传给后台