基本說明
使用說明
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
});
