微信JS接口

時間  2019-11-30
標籤 微信 接口 欄目 JavaScript 简体版
原文   原文鏈接

微信JS接口 分享到朋友圈 分享給朋友 分享到QQ 拍照或從手機相冊中選圖 識別音頻並返回識別結果 使用微信內置地圖查看位置
來源：http://www.cnblogs.com/txw1958/p/weixin-js.html html

基本說明

使用說明

1.引入JS文件

在須要調用JS接口的頁面引入以下JS文件，（支持https）：http://res.wx.qq.com/open/js/jweixin-1.0.0.jsgit

備註：支持使用 AMD/CMD 標準模塊加載方法加載web

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對象)來調用，參數是一個對象，除了每一個接口自己須要傳的參數以外，還有如下通用參數：api

  1. success：接口調用成功時執行的回調函數。
  2. fail：接口調用失敗時執行的回調函數。
  3. complete：接口調用完成時執行的回調函數，不管成功或失敗都會執行。
  4. cancel：用戶點擊取消時的回調函數，僅部分有用戶取消操做的api纔會用到。
  5. trigger: 監聽Menu中的按鈕點擊時觸發的方法，該方法僅支持Menu中的相關接口。


以上幾個函數都帶有一個參數，類型爲對象，其中除了每一個接口自己返回的數據以外，還有一個通用屬性errMsg，其值格式以下：瀏覽器

  1. 調用成功時："xxx:ok" ，其中xxx爲調用的接口名
  2. 用戶取消時："xxx:cancel"，其中xxx爲調用的接口名
  3. 調用失敗時：其值爲具體錯誤信息

基礎接口

判斷當前客戶端版本是否支持指定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
});

 

附錄1-JSSDK使用權限簽名算法

jsapi_ticket

生成簽名以前必須先了解一下jsapi_ticket，jsapi_ticket是公衆號用於調用微信JS接口的臨時票據。正常狀況下，jsapi_ticket的有效期爲7200秒，經過access_token來獲取。因爲獲取jsapi_ticket的api調用次數很是有限，頻繁刷新jsapi_ticket會致使api調用受限，影響自身業務，開發者必須在本身的服務全局緩存jsapi_ticket 。服務器

  1. 參考如下文檔獲取access_token（有效期7200秒，開發者必須在本身的服務全局緩存access_token）：../12/4b08382e91217687730a2dfc71e9218c.html
  2. 用第一步拿到的access_token 採用http GET方式請求得到jsapi_ticket（有效期7200秒，開發者必須在本身的服務全局緩存jsapi_ticket）：https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=ACCESS_TOKEN&type=jsapi

成功返回以下JSON：微信

{
"errcode":0,
"errmsg":"ok",
"ticket":"bxLdikRXVbTPdHSM05e5u5sUoXNKd8-41ZO3MhKoyN5OfkWITDGgnr2fwJ0m9E8NYzWKVZvdVtaUgWvsdshFKA",
"expires_in":7200
}

得到jsapi_ticket以後，就能夠生成JSSDK權限驗證的簽名了。

 

簽名算法

簽名生成規則以下：參與簽名的字段包括noncestr（隨機字符串）, 有效的jsapi_ticket, timestamp（時間戳）, url（當前網頁的URL，不包含#及其後面部分） 。對全部待簽名參數按照字段名的ASCII 碼從小到大排序（字典序）後，使用URL鍵值對的格式（即key1=value1&key2=value2…）拼接成字符串string1。這裏須要注意的是全部參數名均爲小寫字符。對string1做sha1加密，字段名和字段值都採用原始值，不進行URL 轉義。


即signature=sha1(string1)。 示例：

  • noncestr=Wm3WZYTPz0wzccnW
  • jsapi_ticket=sM4AOVdWfPE4DxkXGEs8VMCPGGVi4C3VM0P37wVUCFvkVAy_90u5h9nbSlYy3-Sl-HhTdfl2fzFy1AOcHKP7qg
  • timestamp=1414587457
  • url=http://mp.weixin.qq.com


步驟1. 對全部待簽名參數按照字段名的ASCII 碼從小到大排序（字典序）後，使用URL鍵值對的格式（即key1=value1&key2=value2…）拼接成字符串string1：

jsapi_ticket=sM4AOVdWfPE4DxkXGEs8VMCPGGVi4C3VM0P37wVUCFvkVAy_90u5h9nbSlYy3-Sl-HhTdfl2fzFy1AOcHKP7qg&noncestr=Wm3WZYTPz0wzccnW&timestamp=1414587457&url=http://mp.weixin.qq.com


步驟2. 對string1進行sha1簽名，獲得signature：

f4d90daf4b3bca3078ab155816175ba34c443a7b

注意事項

  1. 簽名用的noncestr和timestamp必須與wx.config中的nonceStr和timestamp相同。
  2. 簽名用的url必須是調用JS接口頁面的完整URL。
  3. 出於安全考慮，開發者必須在服務器端實現簽名的邏輯。

 

附錄2-全部JS接口列表

  • onMenuShareTimeline
  • onMenuShareAppMessage
  • onMenuShareQQ
  • onMenuShareWeibo
  • startRecord
  • stopRecord
  • onVoiceRecordEnd
  • playVoice
  • pauseVoice
  • stopVoice
  • onVoicePlayEnd
  • uploadVoice
  • downloadVoice
  • chooseImage
  • previewImage
  • uploadImage
  • downloadImage
  • translateVoice
  • getNetworkType
  • openLocation
  • getLocation
  • hideOptionMenu
  • showOptionMenu
  • hideMenuItems
  • showMenuItems
  • hideAllNonBaseMenuItem
  • showAllNonBaseMenuItem
  • closeWindow
  • scanQRCode
  • chooseWXPay
  • getLatestAddress
  • editAddress
  • openProductSpecificView
  • addCard
  • chooseCard
  • openCard

 

 

附錄3-全部按鈕列表

基本類

  • 舉報: "menuItem:exposeArticle"
  • 調整字體: "menuItem:setFont"
  • 日間模式: "menuItem:dayMode"
  • 夜間模式: "menuItem:nightMode"
  • 刷新: "menuItem:refresh"
  • 查看公衆號（已添加）: "menuItem:profile"
  • 查看公衆號（未添加）: "menuItem:addContact"

傳播類

  • 發送給朋友: "menuItem:share:appMessage"
  • 分享到朋友圈: "menuItem:share:timeline"
  • 分享到QQ: "menuItem:share:qq"
  • 分享到Weibo: "menuItem:share:weiboApp"
  • 收藏: "menuItem:favorite"
  • 分享到FB: "menuItem:share:facebook"

保護類

  • 調試: "menuItem:jsDebug"
  • 編輯標籤: "menuItem:editTag"
  • 刪除: "menuItem:delete"
  • 複製連接: "menuItem:copyUrl"
  • 原網頁: "menuItem:originPage"
  • 閱讀模式: "menuItem:readMode"
  • 在QQ瀏覽器中打開: "menuItem:openWithQQBrowser"
  • 在Safari中打開: "menuItem:openWithSafari"
  • 郵件: "menuItem:share:email"
  • 一些特殊公衆號: "menuItem:share:brand"

 

附錄4-位置與地址簽名生成算法

addrSign的生成規則與JSSDK權限驗證的簽名生成規則相同（參考附錄1），只是參與簽名參數有所不一樣。參與addrSign的簽名參數有：appId、url（當前網頁url）、timestamp、noncestr、accesstoken（用戶受權憑證，請參照oauth2.0 協議獲取）。

 

附錄5-支付擴展字段及簽名生成算法

訂單詳情（package）擴展字符串定義

在商戶調起JS API 時，商戶須要此時肯定該筆訂單詳情，並將該訂單詳情經過必定的方式進行組合放入package。JS API 調用後，微信將經過package 的內容生成預支付單。下 面將定義package 的所需字段列表以及簽名方法。 接口須要注意：全部傳入參數都是字符串類型！

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程