微信JS-SDK說明文檔

微信JS-SDK功能

概述

微信JS-SDK是微信公眾平臺面向網頁開發者提供的基于微信內的網頁開發工具包。

通過使用微信JS-SDK,網頁開發者可借助微信高效地使用拍照、選圖、語音、位置等手機系統的能力,同時可以直接使用微信分享、掃一掃、卡券、支付等微信特有的能力,為微信用戶提供更優質的網頁體驗。

此文檔面向網頁開發者介紹微信JS-SDK如何使用及相關注意事項。

JSSDK使用步驟

步驟一:綁定域名

先登錄微信公眾平臺進入“公眾號設置”的“功能設置”里填寫“JS接口安全域名”。

備注:登錄后可在“開發者中心”查看對應的接口權限。

步驟二:引入JS文件

在需要調用JS接口的頁面引入如下JS文件,(支持https):http://res.wx.qq.com/open/js/jweixin-1.0.0.js

如需使用搖一搖周邊功能,請引入 http://res.wx.qq.com/open/js/jweixin-1.1.0.js

備注:支持使用 AMD/CMD 標準模塊加載方法加載

步驟三:通過config接口注入權限驗證配置

所有需要使用JS-SDK的頁面必須先注入配置信息,否則將無法調用(同一個url僅需調用一次,對于變化url的SPA的web app可在每次url變化時進行調用,目前Android微信客戶端不支持pushState的H5新特性,所以使用pushState來實現web app的頁面會導致簽名失敗,此問題會在Android6.2中修復)。

wx.config({

    debug: true, // 開啟調試模式,調用的所有api的返回值會在客戶端alert出來,若要查看傳入的參數,可以在pc端打開,參數信息會通過log打出,僅在pc端時才會打印。

    appId: '', // 必填,公眾號的唯一標識

    timestamp: , // 必填,生成簽名的時間戳

    nonceStr: '', // 必填,生成簽名的隨機串

    signature: '',// 必填,簽名,見附錄1

    jsApiList: [] // 必填,需要使用的JS接口列表,所有JS接口列表見附錄2

});

步驟四:通過ready接口處理成功驗證

wx.ready(function(){

    // config信息驗證后會執行ready方法,所有接口調用都必須在config接口獲得結果之后,config是一個客戶端的異步操作,所以如果需要在頁面加載時就調用相關接口,則須把相關接口放在ready函數中調用來確保正確執行。對于用戶觸發時才調用的接口,則可以直接調用,不需要放在ready函數中。

});

步驟五:通過error接口處理失敗驗證

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中的相關接口。

備注:不要嘗試在trigger中使用ajax異步請求修改本次分享的內容,因為客戶端分享操作是一個同步操作,這時候使用ajax的回包會還沒有返回。

以上幾個函數都帶有一個參數,類型為對象,其中除了每個接口本身返回的數據之外,還有一個通用屬性errMsg,其值格式如下:

調用成功時:"xxx:ok" ,其中xxx為調用的接口名

用戶取消時:"xxx:cancel",其中xxx為調用的接口名

調用失敗時:其值為具體錯誤信息

基礎接口

判斷當前客戶端版本是否支持指定JS接口

wx.checkJsApi({

    jsApiList: ['chooseImage'], // 需要檢測的JS接口列表,所有JS接口列表見附錄2,

    success: function(res) {

        // 以鍵值對的形式返回,可用的api值true,不可用為false

        // 如:{"checkResult":{"chooseImage":true},"errMsg":"checkJsApi:ok"}

    }

});

備注:checkJsApi接口是客戶端6.0.2新引入的一個預留接口,第一期開放的接口均可不使用checkJsApi來檢測。

分享接口

請注意不要有誘導分享等違規行為,對于誘導分享行為將永久回收公眾號接口權限,詳細規則請查看:朋友圈管理常見問題 。

獲取“分享到朋友圈”按鈕點擊狀態及自定義分享內容接口

wx.onMenuShareTimeline({

    title: '', // 分享標題

    link: '', // 分享鏈接

    imgUrl: '', // 分享圖標

    success: function () { 

        // 用戶確認分享后執行的回調函數

    },

    cancel: function () { 

        // 用戶取消分享后執行的回調函數

    }

});

獲取“分享給朋友”按鈕點擊狀態及自定義分享內容接口

wx.onMenuShareAppMessage({

    title: '', // 分享標題

    desc: '', // 分享描述

    link: '', // 分享鏈接

    imgUrl: '', // 分享圖標

    type: '', // 分享類型,music、video或link,不填默認為link

    dataUrl: '', // 如果type是music或video,則要提供數據鏈接,默認為空

    success: function () { 

        // 用戶確認分享后執行的回調函數

    },

    cancel: function () { 

        // 用戶取消分享后執行的回調函數

    }

});

獲取“分享到QQ”按鈕點擊狀態及自定義分享內容接口

wx.onMenuShareQQ({

    title: '', // 分享標題

    desc: '', // 分享描述

    link: '', // 分享鏈接

    imgUrl: '', // 分享圖標

    success: function () { 

       // 用戶確認分享后執行的回調函數

    },

    cancel: function () { 

       // 用戶取消分享后執行的回調函數

    }

});

獲取“分享到騰訊微博”按鈕點擊狀態及自定義分享內容接口

wx.onMenuShareWeibo({

    title: '', // 分享標題

    desc: '', // 分享描述

    link: '', // 分享鏈接

    imgUrl: '', // 分享圖標

    success: function () { 

       // 用戶確認分享后執行的回調函數

    },

    cancel: function () { 

        // 用戶取消分享后執行的回調函數

    }

});

獲取“分享到QQ空間”按鈕點擊狀態及自定義分享內容接口

wx.onMenuShareQZone({

    title: '', // 分享標題

    desc: '', // 分享描述

    link: '', // 分享鏈接

    imgUrl: '', // 分享圖標

    success: function () { 

       // 用戶確認分享后執行的回調函數

    },

    cancel: function () { 

        // 用戶取消分享后執行的回調函數

    }

});

圖像接口

拍照或從手機相冊中選圖接口

wx.chooseImage({

    count: 1, // 默認9

    sizeType: ['original', 'compressed'], // 可以指定是原圖還是壓縮圖,默認二者都有

    sourceType: ['album', 'camera'], // 可以指定來源是相冊還是相機,默認二者都有

    success: function (res) {

        var localIds = res.localIds; // 返回選定照片的本地ID列表,localId可以作為img標簽的src屬性顯示圖片

    }

});

預覽圖片接口

wx.previewImage({

    current: '', // 當前顯示圖片的http鏈接

    urls: [] // 需要預覽的圖片http鏈接列表

});

上傳圖片接口

wx.uploadImage({

    localId: '', // 需要上傳的圖片的本地ID,由chooseImage接口獲得

    isShowProgressTips: 1, // 默認為1,顯示進度提示

    success: function (res) {

        var serverId = res.serverId; // 返回圖片的服務器端ID

    }

});

備注:上傳圖片有效期3天,可用微信多媒體接口下載圖片到自己的服務器,此處獲得的 serverId 即 media_id。

下載圖片接口

wx.downloadImage({

    serverId: '', // 需要下載的圖片的服務器端ID,由uploadImage接口獲得

    isShowProgressTips: 1, // 默認為1,顯示進度提示

    success: function (res) {

        var localId = res.localId; // 返回圖片下載后的本地ID

    }

});

音頻接口

開始錄音接口

wx.startRecord();

停止錄音接口

wx.stopRecord({

    success: function (res) {

        var localId = res.localId;

    }

});

監聽錄音自動停止接口

wx.onVoiceRecordEnd({

    // 錄音時間超過一分鐘沒有停止的時候會執行 complete 回調

    complete: function (res) {

        var localId = res.localId; 

    }

});

播放語音接口

wx.playVoice({

    localId: '' // 需要播放的音頻的本地ID,由stopRecord接口獲得

});

暫停播放接口

wx.pauseVoice({

    localId: '' // 需要暫停的音頻的本地ID,由stopRecord接口獲得

});

停止播放接口

wx.stopVoice({

    localId: '' // 需要停止的音頻的本地ID,由stopRecord接口獲得

});

監聽語音播放完畢接口

wx.onVoicePlayEnd({

    success: function (res) {

        var localId = res.localId; // 返回音頻的本地ID

    }

});

上傳語音接口

wx.uploadVoice({

    localId: '', // 需要上傳的音頻的本地ID,由stopRecord接口獲得

    isShowProgressTips: 1, // 默認為1,顯示進度提示

        success: function (res) {

        var serverId = res.serverId; // 返回音頻的服務器端ID

    }

});

備注:上傳語音有效期3天,可用微信多媒體接口下載語音到自己的服務器,此處獲得的 serverId 即 media_id,參考文檔 .目前多媒體文件下載接口的頻率限制為10000次/天,如需要調高頻率,請登錄微信公眾平臺,在開發 - 接口權限的列表中,申請提高臨時上限。

下載語音接口

wx.downloadVoice({

    serverId: '', // 需要下載的音頻的服務器端ID,由uploadVoice接口獲得

    isShowProgressTips: 1, // 默認為1,顯示進度提示

    success: function (res) {

        var localId = res.localId; // 返回音頻的本地ID

    }

});

智能接口

識別音頻并返回識別結果接口