微信JS接口 分享到朋友圈 分享給朋友 分享到QQ 拍照或從手機相冊中選圖 識別音頻並返回識別結果 使用微信內置地圖查看位置
微信JS-SDK是微信公眾平台面向網頁開發者提供的基於微信內的網頁開發工具包。
通過使用微信JS-SDK，網頁開發者可借助微信高效地使用拍照、選圖、語音、位置等手機系統的能力，同時可以直接使用微信分享、掃一掃、卡券、支付等微信特有的能力，為微信用戶提供更優質的網頁體驗。
此文檔面向網頁開發者介紹微信JS-SDK如何使用及相關注意事項。
在使用微信JS-SDK對應的JS接口前，需確保公眾號已獲得使用對應JS接口的權限，可登錄微信公眾平台進入“開發者中心”查看對應的接口權限。
注意： 所有的JS接口只能在公眾號綁定的域名下調用，公眾號開發者需要先登錄微信公眾平台進入“公眾號設置”》“功能設置”裡填寫“JS接口安全域名”。
在需要調用JS接口的頁面引入如下JS文件，（支持https）：http://res.wx.qq.com/open/js/jweixin-1.0.0.js
備注：支持使用 AMD/CMD 標准模塊加載方法加載
所有需要使用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
});
wx.ready(function(){
// config信息驗證後會執行ready方法，所有接口調用都必須在config接口獲得結果之後，config是一個客戶端的異步操作，所以如果需要在頁面加載時就調用相關接口，則須把相關接口放在ready函數中調用來確保正確執行。對於用戶觸發時才調用的接口，則可以直接調用，不需要放在ready函數中。
});
wx.error(function(res){
// config信息驗證失敗會執行error函數，如簽名過期導致驗證失敗，具體錯誤信息可以打開config的debug模式查看，也可以在返回的res參數中查看，對於SPA可以在這裡更新簽名。
});
所有接口通過wx對象(也可使用jWeixin對象)來調用，參數是一個對象，除了每個接口本身需要傳的參數之外，還有以下通用參數：
以上幾個函數都帶有一個參數，類型為對象，其中除了每個接口本身返回的數據之外，還有一個通用屬性errMsg，其值格式如下：
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 () {
// 用戶取消分享後執行的回調函數
}
});
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 (res) {
var result = res.resultStr; // 當needResult 為 1 時，掃碼返回的結果
}
});
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
});
jsapi_ticket
生成簽名之前必須先了解一下jsapi_ticket，jsapi_ticket是公眾號用於調用微信JS接口的臨時票據。正常情況下，jsapi_ticket的有效期為7200秒，通過access_token來獲取。由於獲取jsapi_ticket的api調用次數非常有限，頻繁刷新jsapi_ticket會導致api調用受限，影響自身業務，開發者必須在自己的服務全局緩存jsapi_ticket 。
成功返回如下JSON：
{
"errcode":0,
"errmsg":"ok",
"ticket":"bxLdikRXVbTPdHSM05e5u5sUoXNKd8-41ZO3MhKoyN5OfkWITDGgnr2fwJ0m9E8NYzWKVZvdVtaUgWvsdshFKA",
"expires_in":7200
}
獲得jsapi_ticket之後，就可以生成JS-SDK權限驗證的簽名了。
簽名算法
簽名生成規則如下：參與簽名的字段包括noncestr（隨機字符串）, 有效的jsapi_ticket, timestamp（時間戳）, url（當前網頁的URL，不包含#及其後面部分） 。對所有待簽名參數按照字段名的ASCII 碼從小到大排序（字典序）後，使用URL鍵值對的格式（即key1=value1&key2=value2…）拼接成字符串string1。這裡需要注意的是所有參數名均為小寫字符。對string1作sha1加密，字段名和字段值都采用原始值，不進行URL 轉義。
即signature=sha1(string1)。
示例：
步驟1. 對所有待簽名參數按照字段名的ASCII 碼從小到大排序（字典序）後，使用URL鍵值對的格式（即key1=value1&key2=value2…）拼接成字符串string1：
jsapi_ticket=sM4AOVdWfPE4DxkXGEs8VMCPGGVi4C3VM0P37wVUCFvkVAy_90u5h9nbSlYy3-Sl-HhTdfl2fzFy1AOcHKP7qg&noncestr=Wm3WZYTPz0wzccnW×tamp=1414587457&url=http://mp.weixin.qq.com
步驟2. 對string1進行sha1簽名，得到signature：
f4d90daf4b3bca3078ab155816175ba34c443a7b
注意事項
版本1.0.0接口
基本類
傳播類
保護類
addrSign的生成規則與JS-SDK權限驗證的簽名生成規則相同（參考附錄1），只是參與簽名參數有所不同。參與addrSign的簽名參數有：appId、url（當前網頁url）、timestamp、noncestr、accesstoken（用戶授權憑證，請參照oauth2.0 協議獲取）。
訂單詳情（package）擴展字符串定義
在商戶調起JS API 時，商戶需要此時確定該筆訂單詳情，並將該訂單詳情通過一定的方式進行組合放入package。JS API 調用後，微信將通過package 的內容生成預支付單。下 面將定義package 的所需字段列表以及簽名方法。 接口需要注意：所有傳入參數都是字符串類型！
package 所需字段列表:
transport_fee + product_fee=total_fee；
product_fee 商品費用 否 字符串類型 物流費用，單位為分。如果有值，必須保證transport_fee + product_fee=total_fee；
goods_tag 商品標記 否 字符串類型 商品標記，優惠券時可能用到； input_charset 傳入參數字符編碼 是 字符串類型 取值范圍："GBK"、"UTF-8"，默認："GBK"package 生成方法： 由於package中攜帶了生成訂單的詳細信息，因此在微信將對package裡面的內容進行鑒 權，確定package攜帶的信息是真實、有效、合理的。因此，這裡將定義生成package字符 串的方法。
下面定義了一段生成package字符串的示范過程：
假設以下為package傳入參數：
i: 經過a過程URL鍵值對字典序排序後的字符串string1為：
bank_type=WX&body=支付測試&fee_type=1&input_charset=UTF-8¬ify_url=http://we ixin.qq.com&out_trade_no=7240b65810859cbf2a8d9f76a638c0a3&partner=1900000109&spbill_ create_ip=196.168.1.1&total_fee=1
ii：經過b過程後得到sign為：
sign =md5(string1&key=8934e7d15453e97507ef794cf7b0519d).toUpperCase =md5(bank_type=WX&body=支付測試&fee_type=1&input_charset=UTF-8¬ify_url=htt p://weixin.qq.com&out_trade_no=7240b65810859cbf2a8d9f76a638c0a3&partner=1900000109& spbill_create_ip=196.168.1.1&total_fee=1&key=8934e7d15453e97507ef794cf7b0519d).toUpper Case() ="7f77b507b755b3262884291517e380f8".toUpperCase() ="7F77B507B755B3262884291517E380F8"
iii：再對傳入參數中的每一個鍵值對中的value進行urlencode編碼後得到：
bank_type=WX&body=%E6%94%AF%E4%BB%98%E6%B5%8B%E8%AF%95&fee_typ e=1&input_charset=UTF-8¬ify_url=http%3A%2F%2Fweixin.qq.com&out_trade_no=7240b6 5810859cbf2a8d9f76a638c0a3&partner=1900000109&spbill_create_ip=196.168.1.1&total_fee=1
iv：拼接上sign後得到最終package結果：
bank_type=WX&body=%E6%94%AF%E4%BB%98%E6%B5%8B%E8%AF%95&fee_typ e=1&input_charset=UTF-8¬ify_url=http%3A%2F%2Fweixin.qq.com&out_trade_no=7240b6 5810859cbf2a8d9f76a638c0a3&partner=1900000109&spbill_create_ip=196.168.1.1&total_fee=1 &sign=7F77B507B755B3262884291517E380F8
支付簽名（paySign）生成方法
paySign字段是對本次發起JSAPI的行為進行鑒權，只有通過了paySign鑒權，才能繼 續對package鑒權並生成預支付單。paySign的生成規則與JS-SDK權限驗證的簽名生成規則相同（參考附錄1）。
參與paySign簽名的字段包括：appid、timestamp、noncestr、package以及appkey（即
paySignkey）。
卡券擴展字段cardExt說明
cardExt本身是一個JSON字符串，是商戶為該張卡券分配的唯一性信息，包含以下字段：
由商戶生成後傳入。
signature 是 簽名，商戶將接口列表中的參數按照指定方式進行簽名,簽名方式使用SHA1,具體簽名方案參見下文;由商戶按照規范簽名後傳入。 balance 否 紅包余額，以分為單位。紅包類型必填（LUCKY_MONEY），其他卡券類型不填。簽名說明
卡券簽名cardSign說明
調用config 接口的時候傳入參數 debug: true 可以開啟debug模式，頁面會alert出錯誤信息。以下為常見錯誤及解決方法：
DEMO頁面：
http://demo.open.weixin.qq.com/jssdk
示例代碼：
http://demo.open.weixin.qq.com/jssdk/sample.zip
備注：鏈接中包含php、java、nodejs以及python的示例代碼供第三方參考，第三方切記要對獲取的accesstoken以及jsapi_ticket進行緩存以確保不會觸發頻率限制。