基本說明
使用說明
1.引入JS文件
在需要調用JS接口的頁面引入如下JS文件，（支持https）：http://res.wx.qq.com/open/js/jweixin-1.0.0.js
備注：支持使用 AMD/CMD 標准模塊加載方法加載
2.注入配置config接口
所有需要使用JSSDK的頁面必須先注入配置信息，否則將無法調用（同一個url僅需調用一次，對於變化url的SPA的web app可在每次url變化時進行調用）。
復制代碼 代碼如下:
wx.config({
debug: true, // 開啟調試模式,調用的所有api的返回值會在客戶端alert出來，若要查看傳入的參數，可以在pc端打開，參數信息會通過log打出，僅在pc端時才會打印。
appId: '', // 必填，公眾號的唯一標識
timestamp: , // 必填，生成簽名的時間戳
nonceStr: '', // 必填，生成簽名的隨機串
signature: '',// 必填，簽名，見附錄1
jsApiList: [] // 必填，需要使用的JS接口列表，所有JS接口列表見附錄2
});
3.驗證通過ready接口
復制代碼 代碼如下:
wx.ready(function(){
// config信息驗證後會執行ready方法，所有接口調用都必須在config接口獲得結果之後，config是一個客戶端的異步操作，所以如果需要在頁面加載時就調用相關接口，則須把相關接口放在ready函數中調用來確保正確執行。對於用戶觸發時才調用的接口，則可以直接調用，不需要放在ready函數中。
});
4.驗證失敗error接口
復制代碼 代碼如下:
wx.error(function(res){
// config信息驗證失敗會執行error函數，如簽名過期導致驗證失敗，具體錯誤信息可以打開config的debug模式查看，也可以在返回的res參數中查看，對於SPA可以在這裡更新簽名。
});
接口調用說明
所有接口通過wx對象(也可使用jWeixin對象)來調用，參數是一個對象，除了每個接口本身需要傳的參數之外，還有以下通用參數：
success：接口調用成功時執行的回調函數。
fail：接口調用失敗時執行的回調函數。
complete：接口調用完成時執行的回調函數，無論成功或失敗都會執行。
cancel：用戶點擊取消時的回調函數，僅部分有用戶取消操作的api才會用到。
trigger: 監聽Menu中的按鈕點擊時觸發的方法，該方法僅支持Menu中的相關接口。
以上幾個函數都帶有一個參數，類型為對象，其中除了每個接口本身返回的數據之外，還有一個通用屬性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"}
});
分享接口
獲取“分享到朋友圈”按鈕點擊狀態及自定義分享內容接口
復制代碼 代碼如下:
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 () {
// 用戶取消分享後執行的回調函數
}
});
圖像接口
拍照或從手機相冊中選圖接口
復制代碼 代碼如下:
wx.chooseImage({
success: function (res) {
var localIds = res.localIds; // 返回選定照片的本地ID列表，localId可以作為img標簽的src屬性顯示圖片
}
});
預覽圖片接口
復制代碼 代碼如下:
wx.previewImage({
current: '', // 當前顯示的圖片鏈接
urls: [] // 需要預覽的圖片鏈接列表
});
上傳圖片接口
復制代碼 代碼如下:
wx.uploadImage({
localId: '', // 需要上傳的圖片的本地ID，由chooseImage接口獲得
isShowProgressTips: 1// 默認為1，顯示進度提示
success: function (res) {
var serverId = res.serverId; // 返回圖片的服務器端ID
}
});
備注：可用微信下載多媒體文件接口下載上傳的圖片，此處獲得的 serverId 即 media_id，參考文檔../12/58bfcfabbd501c7cd77c19bd9cfa8354.html
下載圖片接口
復制代碼 代碼如下:
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({
serverId: '', // 需要下載的音頻的服務器端ID，由uploadVoice接口獲得
success: function (res) {
var localId = res.localId; // 返回音頻的本地ID
}
});
上傳語音接口
復制代碼 代碼如下:
wx.uploadVoice({
localId: '', // 需要上傳的音頻的本地ID，由stopRecord接口獲得
isShowProgressTips: 1// 默認為1，顯示進度提示
success: function (res) {
var serverId = res.serverId; // 返回音頻的服務器端ID
}
});
備注：可用微信下載多媒體文件接口下載上傳的語音，此處獲得的 serverId 即 media_id，參考文檔../12/58bfcfabbd501c7cd77c19bd9cfa8354.html
下載語音接口
復制代碼 代碼如下:
wx.downloadVoice({
serverId: '', // 需要下載的音頻的服務器端ID，由uploadVoice接口獲得
isShowProgressTips: 1// 默認為1，顯示進度提示
success: function (res) {
var localId = res.localId; // 返回音頻的本地ID
}
});
智能接口
識別音頻並返回識別結果接口
復制代碼 代碼如下:
wx.translateVoice({
localId: '', // 需要識別的音頻的本地Id，由錄音相關接口獲得
isShowProgressTips: 1, // 默認為1，顯示進度提示
success: function (res) {
alert(res.translateResult); // 語音識別的結果
}
});
設備信息
獲取網絡狀態接口
復制代碼 代碼如下:
wx.getNetworkType({
success: function (res) {
var networkType = res.networkType; // 返回網絡類型2g，3g，4g，wifi
}
});
地理位置
使用微信內置地圖查看位置接口
復制代碼 代碼如下:
wx.openLocation({
latitude: 0, // 緯度，浮點數，范圍為90 ~ -90
longitude: 0, // 經度，浮點數，范圍為180 ~ -180。
name: '', // 位置名
address: '', // 地址詳情說明
scale: 1, // 地圖縮放級別,整形值,范圍從1~28。默認為最大
infoUrl: '' // 在查看位置界面底部顯示的超鏈接,可點擊跳轉
});
獲取地理位置接口
復制代碼 代碼如下:
wx.getLocation({
timestamp: 0, // 位置簽名時間戳，僅當需要兼容6.0.2版本之前時提供
nonceStr: '', // 位置簽名隨機串，僅當需要兼容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 時，掃碼返回的結果
}
});
收獲地址
編輯收貨地址接口
復制代碼 代碼如下:
wx.editAddress(
timestamp: 0, // 位置簽名時間戳，僅當需要兼容6.0.2版本之前時提供
nonceStr: '', // 位置簽名隨機串，僅當需要兼容6.0.2版本之前時提供
addrSign: '', // 位置簽名，僅當需要兼容6.0.2版本之前時提供，詳見附錄4
success: function (res) {
var userName = res.userName; // 收貨人姓名
var telNumber = res.telNumber; // 收貨人電話
var postalCode = res.postalCode; // 郵編
var provinceName = res.provinceName; // 國標收貨地址第一級地址
var cityName = res.cityName; // 國標收貨地址第二級地址
var countryName = res.countryName; // 國標收貨地址第三級地址
var address = res.address; // 詳細收貨地址信息
var nationalCode = res.nationalCode; // 收貨地址國家碼
}
});
獲取最近的收貨地址接口
復制代碼 代碼如下:
wx.getLatestAddress({
timestamp: 0, // 位置簽名時間戳，僅當需要兼容6.0.2版本之前時提供
nonceStr: '', // 位置簽名隨機串，僅當需要兼容6.0.2版本之前時提供
addrSign: '', // 位置簽名，僅當需要兼容6.0.2版本之前時提供，詳見附錄4
success: function (res) {
var userName = res.userName; // 收貨人姓名
var telNumber = res.telNumber; // 收貨人電話
var postalCode = res.postalCode; // 郵編
var provinceName = res.provinceName; // 國標收貨地址第一級地址
var cityName = res.cityName; // 國標收貨地址第二級地址
var countryName = res.countryName; // 國標收貨地址第三級地址
var address = res.address; // 詳細收貨地址信息
var nationalCode = res.nationalCode; // 收貨地址國家碼
}
});
微信小店
跳轉微信商品頁接口
復制代碼 代碼如下:
wx.openProductSpecificView({
productId: '', // 商品id
viewType: '' // 0.默認值，普通商品詳情頁1.掃一掃商品詳情頁2.小店商品詳情頁
});
微信卡券
調起適用於門店的卡券列表並獲取用戶選擇列表
復制代碼 代碼如下:
wx.chooseCard({
shopId: '', // 門店Id
cardType: '', // 卡券類型
cardId: '', // 卡券Id
timeStamp: 0, // 卡券簽名時間戳
nonceStr: '', // 卡券簽名隨機串
cardSign: '', // 卡券簽名，詳見附錄6
success: function (res) {
var cardList= res.cardList; // 用戶選中的卡券列表信息
}
});
批量添加卡券接口
復制代碼 代碼如下:
wx.addCard({
cardList: [{
cardId: '',
cardExt: ''
}], // 需要添加的卡券列表
success: function (res) {
var cardList = res.cardList; // 添加的卡券列表信息
}
});
查看微信卡包中的卡券接口
復制代碼 代碼如下:
wx.openCard({
cardList: [{
cardId: '',
code: ''
}]// 需要打開的卡券列表
});
微信支付
發起一個微信支付請求
復制代碼 代碼如下:
wx.chooseWXPay({
timestamp: 0, // 支付簽名時間戳
noncestr: '', // 支付簽名隨機串
package: '', // 訂單詳情擴展字符串，詳見附錄5
paySign: '', // 支付簽名，詳見附錄5
});