基本說(shuō)明
使用說(shuō)明
1.引入JS文件
在需要調(diào)用JS接口的頁(yè)面引入如下JS文件，（支持https）：http://res.wx.qq.com/open/js/jweixin-1.0.0.js
備注：支持使用 AMD/CMD 標(biāo)準(zhǔn)模塊加載方法加載
2.注入配置config接口
所有需要使用JSSDK的頁(yè)面必須先注入配置信息，否則將無(wú)法調(diào)用（同一個(gè)url僅需調(diào)用一次，對(duì)于變化url的SPA的web app可在每次url變化時(shí)進(jìn)行調(diào)用）。
wx.config({
debug: true, // 開(kāi)啟調(diào)試模式,調(diào)用的所有api的返回值會(huì)在客戶端alert出來(lái)，若要查看傳入的參數(shù)，可以在pc端打開(kāi)，參數(shù)信息會(huì)通過(guò)log打出，僅在pc端時(shí)才會(huì)打印。
appId: '', // 必填，公眾號(hào)的唯一標(biāo)識(shí)
timestamp: , // 必填，生成簽名的時(shí)間戳
nonceStr: '', // 必填，生成簽名的隨機(jī)串
signature: '',// 必填，簽名，見(jiàn)附錄1
jsApiList: [] // 必填，需要使用的JS接口列表，所有JS接口列表見(jiàn)附錄2
});
3.驗(yàn)證通過(guò)ready接口
wx.ready(function(){
// config信息驗(yàn)證后會(huì)執(zhí)行ready方法，所有接口調(diào)用都必須在config接口獲得結(jié)果之后，config是一個(gè)客戶端的異步操作，所以如果需要在頁(yè)面加載時(shí)就調(diào)用相關(guān)接口，則須把相關(guān)接口放在ready函數(shù)中調(diào)用來(lái)確保正確執(zhí)行。對(duì)于用戶觸發(fā)時(shí)才調(diào)用的接口，則可以直接調(diào)用，不需要放在ready函數(shù)中。
});
4.驗(yàn)證失敗error接口
wx.error(function(res){
// config信息驗(yàn)證失敗會(huì)執(zhí)行error函數(shù)，如簽名過(guò)期導(dǎo)致驗(yàn)證失敗，具體錯(cuò)誤信息可以打開(kāi)config的debug模式查看，也可以在返回的res參數(shù)中查看，對(duì)于SPA可以在這里更新簽名。
});
接口調(diào)用說(shuō)明
所有接口通過(guò)wx對(duì)象(也可使用jWeixin對(duì)象)來(lái)調(diào)用，參數(shù)是一個(gè)對(duì)象，除了每個(gè)接口本身需要傳的參數(shù)之外，還有以下通用參數(shù)：
success：接口調(diào)用成功時(shí)執(zhí)行的回調(diào)函數(shù)。
fail：接口調(diào)用失敗時(shí)執(zhí)行的回調(diào)函數(shù)。
complete：接口調(diào)用完成時(shí)執(zhí)行的回調(diào)函數(shù)，無(wú)論成功或失敗都會(huì)執(zhí)行。
cancel：用戶點(diǎn)擊取消時(shí)的回調(diào)函數(shù)，僅部分有用戶取消操作的api才會(huì)用到。
trigger: 監(jiān)聽(tīng)Menu中的按鈕點(diǎn)擊時(shí)觸發(fā)的方法，該方法僅支持Menu中的相關(guān)接口。
以上幾個(gè)函數(shù)都帶有一個(gè)參數(shù)，類型為對(duì)象，其中除了每個(gè)接口本身返回的數(shù)據(jù)之外，還有一個(gè)通用屬性errMsg，其值格式如下：
調(diào)用成功時(shí)："xxx:ok" ，其中xxx為調(diào)用的接口名
用戶取消時(shí)："xxx:cancel"，其中xxx為調(diào)用的接口名
調(diào)用失敗時(shí)：其值為具體錯(cuò)誤信息
基礎(chǔ)接口
判斷當(dāng)前客戶端版本是否支持指定JS接口
wx.checkJsApi({
jsApiList: ['chooseImage'] // 需要檢測(cè)的JS接口列表，所有JS接口列表見(jiàn)附錄2,
success: function(res) {
// 以鍵值對(duì)的形式返回，可用的api值true，不可用為false
// 如：{"checkResult":{"chooseImage":true},"errMsg":"checkJsApi:ok"}
});
分享接口
獲取“分享到朋友圈”按鈕點(diǎn)擊狀態(tài)及自定義分享內(nèi)容接口
wx.onMenuShareTimeline({
title: '', // 分享標(biāo)題
link: '', // 分享鏈接
imgUrl: '', // 分享圖標(biāo)
success: function () {
// 用戶確認(rèn)分享后執(zhí)行的回調(diào)函數(shù)
},
cancel: function () {
// 用戶取消分享后執(zhí)行的回調(diào)函數(shù)
}
});
獲取“分享給朋友”按鈕點(diǎn)擊狀態(tài)及自定義分享內(nèi)容接口
wx.onMenuShareAppMessage({
title: '', // 分享標(biāo)題
desc: '', // 分享描述
link: '', // 分享鏈接
imgUrl: '', // 分享圖標(biāo)
type: '', // 分享類型,music、video或link，不填默認(rèn)為link
dataUrl: '', // 如果type是music或video，則要提供數(shù)據(jù)鏈接，默認(rèn)為空
success: function () {
// 用戶確認(rèn)分享后執(zhí)行的回調(diào)函數(shù)
},
cancel: function () {
// 用戶取消分享后執(zhí)行的回調(diào)函數(shù)
}
});
獲取“分享到QQ”按鈕點(diǎn)擊狀態(tài)及自定義分享內(nèi)容接口
wx.onMenuShareQQ({
title: '', // 分享標(biāo)題
desc: '', // 分享描述
link: '', // 分享鏈接
imgUrl: '' // 分享圖標(biāo)
success: function () {
// 用戶確認(rèn)分享后執(zhí)行的回調(diào)函數(shù)
},
cancel: function () {
// 用戶取消分享后執(zhí)行的回調(diào)函數(shù)
}
});
獲取“分享到騰訊微博”按鈕點(diǎn)擊狀態(tài)及自定義分享內(nèi)容接口
wx.onMenuShareWeibo({
title: '', // 分享標(biāo)題
desc: '', // 分享描述
link: '', // 分享鏈接
imgUrl: '' // 分享圖標(biāo)
success: function () {
// 用戶確認(rèn)分享后執(zhí)行的回調(diào)函數(shù)
},
cancel: function () {
// 用戶取消分享后執(zhí)行的回調(diào)函數(shù)
}
});
圖像接口
拍照或從手機(jī)相冊(cè)中選圖接口
wx.chooseImage({
success: function (res) {
var localIds = res.localIds; // 返回選定照片的本地ID列表，localId可以作為img標(biāo)簽的src屬性顯示圖片
}
});
預(yù)覽圖片接口
wx.previewImage({
current: '', // 當(dāng)前顯示的圖片鏈接
urls: [] // 需要預(yù)覽的圖片鏈接列表
});
上傳圖片接口
wx.uploadImage({
localId: '', // 需要上傳的圖片的本地ID，由chooseImage接口獲得
isShowProgressTips: 1// 默認(rèn)為1，顯示進(jìn)度提示
success: function (res) {
var serverId = res.serverId; // 返回圖片的服務(wù)器端ID
}
});
備注：可用微信下載多媒體文件接口下載上傳的圖片，此處獲得的 serverId 即 media_id，參考文檔../12/58bfcfabbd501c7cd77c19bd9cfa8354.html
下載圖片接口
wx.downloadImage({
serverId: '', // 需要下載的圖片的服務(wù)器端ID，由uploadImage接口獲得
isShowProgressTips: 1// 默認(rèn)為1，顯示進(jìn)度提示
success: function (res) {
var localId = res.localId; // 返回圖片下載后的本地ID
}
});
音頻接口
開(kāi)始錄音接口
wx.startRecord();
停止錄音接口
wx.stopRecord({
success: function (res) {
var localId = res.localId;
}
});
監(jiān)聽(tīng)錄音自動(dòng)停止接口
wx.onVoiceRecordEnd({
// 錄音時(shí)間超過(guò)一分鐘沒(méi)有停止的時(shí)候會(huì)執(zhí)行 complete 回調(diào)
complete: function (res) {
var localId = res.localId;
}
});
播放語(yǔ)音接口
wx.playVoice({
localId: '' // 需要播放的音頻的本地ID，由stopRecord接口獲得
});
暫停播放接口
wx.pauseVoice({
localId: '' // 需要暫停的音頻的本地ID，由stopRecord接口獲得
});
停止播放接口
wx.stopVoice({
localId: '' // 需要停止的音頻的本地ID，由stopRecord接口獲得
});
監(jiān)聽(tīng)語(yǔ)音播放完畢接口
wx.onVoicePlayEnd({
serverId: '', // 需要下載的音頻的服務(wù)器端ID，由uploadVoice接口獲得
success: function (res) {
var localId = res.localId; // 返回音頻的本地ID
}
});
上傳語(yǔ)音接口
wx.uploadVoice({
localId: '', // 需要上傳的音頻的本地ID，由stopRecord接口獲得
isShowProgressTips: 1// 默認(rèn)為1，顯示進(jìn)度提示
success: function (res) {
var serverId = res.serverId; // 返回音頻的服務(wù)器端ID
}
});
備注：可用微信下載多媒體文件接口下載上傳的語(yǔ)音，此處獲得的 serverId 即 media_id，參考文檔../12/58bfcfabbd501c7cd77c19bd9cfa8354.html
下載語(yǔ)音接口
wx.downloadVoice({
serverId: '', // 需要下載的音頻的服務(wù)器端ID，由uploadVoice接口獲得
isShowProgressTips: 1// 默認(rèn)為1，顯示進(jìn)度提示
success: function (res) {
var localId = res.localId; // 返回音頻的本地ID
}
});
智能接口
識(shí)別音頻并返回識(shí)別結(jié)果接口
wx.translateVoice({
localId: '', // 需要識(shí)別的音頻的本地Id，由錄音相關(guān)接口獲得
isShowProgressTips: 1, // 默認(rèn)為1，顯示進(jìn)度提示
success: function (res) {
alert(res.translateResult); // 語(yǔ)音識(shí)別的結(jié)果
}
});
設(shè)備信息
獲取網(wǎng)絡(luò)狀態(tài)接口
wx.getNetworkType({
success: function (res) {
var networkType = res.networkType; // 返回網(wǎng)絡(luò)類型2g，3g，4g，wifi
}
});
地理位置
使用微信內(nèi)置地圖查看位置接口
wx.openLocation({
latitude: 0, // 緯度，浮點(diǎn)數(shù)，范圍為90 ~ -90
longitude: 0, // 經(jīng)度，浮點(diǎn)數(shù)，范圍為180 ~ -180。
name: '', // 位置名
address: '', // 地址詳情說(shuō)明
scale: 1, // 地圖縮放級(jí)別,整形值,范圍從1~28。默認(rèn)為最大
infoUrl: '' // 在查看位置界面底部顯示的超鏈接,可點(diǎn)擊跳轉(zhuǎn)
});
獲取地理位置接口
wx.getLocation({
timestamp: 0, // 位置簽名時(shí)間戳，僅當(dāng)需要兼容6.0.2版本之前時(shí)提供
nonceStr: '', // 位置簽名隨機(jī)串，僅當(dāng)需要兼容6.0.2版本之前時(shí)提供
addrSign: '', // 位置簽名，僅當(dāng)需要兼容6.0.2版本之前時(shí)提供，詳見(jiàn)附錄4
success: function (res) {
var longitude = res.longitude; // 緯度，浮點(diǎn)數(shù)，范圍為90 ~ -90
var latitude = res.latitude; // 經(jīng)度，浮點(diǎn)數(shù)，范圍為180 ~ -180。
var speed = res.speed; // 速度，以米/每秒計(jì)
var accuracy = res.accuracy; // 位置精度
}
});
界面操作
隱藏右上角菜單接口
wx.hideOptionMenu();
顯示右上角菜單接口
wx.showOptionMenu();
關(guān)閉當(dāng)前網(wǎng)頁(yè)窗口接口
wx.closeWindow();
批量隱藏功能按鈕接口
wx.hideMenuItems({
menuList: [] // 要隱藏的菜單項(xiàng)，所有menu項(xiàng)見(jiàn)附錄3
});
批量顯示功能按鈕接口
wx.showMenuItems({
menuList: [] // 要顯示的菜單項(xiàng)，所有menu項(xiàng)見(jiàn)附錄3
});
隱藏所有非基礎(chǔ)按鈕接口
wx.hideAllNonBaseMenuItem();
顯示所有功能按鈕接口
wx.showAllNonBaseMenuItem();
微信掃一掃
調(diào)起微信掃一掃接口
wx.scanQRCode({
desc: 'scanQRCode desc',
needResult: 0, // 默認(rèn)為0，掃描結(jié)果由微信處理，1則直接返回掃描結(jié)果，
scanType: ["qrCode","barCode"], // 可以指定掃二維碼還是一維碼，默認(rèn)二者都有
success: function () {
var result = res.resultStr; // 當(dāng)needResult 為 1 時(shí)，掃碼返回的結(jié)果
}
});
收獲地址
編輯收貨地址接口
wx.editAddress(
timestamp: 0, // 位置簽名時(shí)間戳，僅當(dāng)需要兼容6.0.2版本之前時(shí)提供
nonceStr: '', // 位置簽名隨機(jī)串，僅當(dāng)需要兼容6.0.2版本之前時(shí)提供
addrSign: '', // 位置簽名，僅當(dāng)需要兼容6.0.2版本之前時(shí)提供，詳見(jiàn)附錄4
success: function (res) {
var userName = res.userName; // 收貨人姓名
var telNumber = res.telNumber; // 收貨人電話
var postalCode = res.postalCode; // 郵編
var provinceName = res.provinceName; // 國(guó)標(biāo)收貨地址第一級(jí)地址
var cityName = res.cityName; // 國(guó)標(biāo)收貨地址第二級(jí)地址
var countryName = res.countryName; // 國(guó)標(biāo)收貨地址第三級(jí)地址
var address = res.address; // 詳細(xì)收貨地址信息
var nationalCode = res.nationalCode; // 收貨地址國(guó)家碼
}
});
獲取最近的收貨地址接口
wx.getLatestAddress({
timestamp: 0, // 位置簽名時(shí)間戳，僅當(dāng)需要兼容6.0.2版本之前時(shí)提供
nonceStr: '', // 位置簽名隨機(jī)串，僅當(dāng)需要兼容6.0.2版本之前時(shí)提供
addrSign: '', // 位置簽名，僅當(dāng)需要兼容6.0.2版本之前時(shí)提供，詳見(jiàn)附錄4
success: function (res) {
var userName = res.userName; // 收貨人姓名
var telNumber = res.telNumber; // 收貨人電話
var postalCode = res.postalCode; // 郵編
var provinceName = res.provinceName; // 國(guó)標(biāo)收貨地址第一級(jí)地址
var cityName = res.cityName; // 國(guó)標(biāo)收貨地址第二級(jí)地址
var countryName = res.countryName; // 國(guó)標(biāo)收貨地址第三級(jí)地址
var address = res.address; // 詳細(xì)收貨地址信息
var nationalCode = res.nationalCode; // 收貨地址國(guó)家碼
}
});
微信小店
跳轉(zhuǎn)微信商品頁(yè)接口
wx.openProductSpecificView({
productId: '', // 商品id
viewType: '' // 0.默認(rèn)值，普通商品詳情頁(yè)1.掃一掃商品詳情頁(yè)2.小店商品詳情頁(yè)
});
微信卡券
調(diào)起適用于門店的卡券列表并獲取用戶選擇列表
wx.chooseCard({
shopId: '', // 門店Id
cardType: '', // 卡券類型
cardId: '', // 卡券Id
timeStamp: 0, // 卡券簽名時(shí)間戳
nonceStr: '', // 卡券簽名隨機(jī)串
cardSign: '', // 卡券簽名，詳見(jiàn)附錄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: ''
}]// 需要打開(kāi)的卡券列表
});
微信支付
發(fā)起一個(gè)微信支付請(qǐng)求
wx.chooseWXPay({
timestamp: 0, // 支付簽名時(shí)間戳
noncestr: '', // 支付簽名隨機(jī)串
package: '', // 訂單詳情擴(kuò)展字符串，詳見(jiàn)附錄5
paySign: '', // 支付簽名，詳見(jiàn)附錄5
});
