微信JS-SDK說明-已開放接口說明
基礎(chǔ)接口
判斷當(dāng)前客戶端版本是否支持指定JS接口
- wx.checkJsApi({
- jsApiList: ['chooseImage'], // 需要檢測的JS接口列表,所有JS接口列表見附錄2,
- success: function(res) {
- // 以鍵值對的形式返回,可用的api值true,不可用為false
- // 如:{"checkResult":{"chooseImage":true},"errMsg":"checkJsApi:ok"}
- });
備注:checkJsApi接口是客戶端6.0.2新引入的一個預(yù)留接口,第一期開放的接口均可不使用checkJsApi來檢測。
分享接口
請注意不要有誘導(dǎo)分享等違規(guī)行為,對于誘導(dǎo)分享行為將永久回收公眾號接口權(quán)限,詳細(xì)規(guī)則請查看:朋友圈管理常見問題 。
獲取“分享到朋友圈”按鈕點擊狀態(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ù)
- }
- });
獲取“分享給朋友”按鈕點擊狀態(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”按鈕點擊狀態(tài)及自定義分享內(nèi)容接口
- x.onMenuShareQQ({
- title: '', // 分享標(biāo)題
- desc: '', // 分享描述
- link: '', // 分享鏈接
- imgUrl: '' // 分享圖標(biāo)
- success: function () {
- // 用戶確認(rèn)分享后執(zhí)行的回調(diào)函數(shù)
- },
- cancel: function () {
- // 用戶取消分享后執(zhí)行的回調(diào)函數(shù)
- }
- });
獲取“分享到騰訊微博”按鈕點擊狀態(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ù)
- }
- });
圖像接口
拍照或從手機相冊中選圖接口
- 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,顯示進度提示
- success: function (res) {
- var serverId = res.serverId; // 返回圖片的服務(wù)器端ID
- }
- });
備注:上傳圖片有效期3天,可用微信多媒體接口下載圖片到自己的服務(wù)器,此處獲得的 serverId 即 media_id,參考文檔 ../12/58bfcfabbd501c7cd77c19bd9cfa8354.html 目前多媒體文件下載接口的頻率限制為10000次,如需要調(diào)高頻率,請郵件weixin-open@qq.com,郵件主題為【申請多媒體接口調(diào)用量】,請對你的項目進行簡單描述,附上產(chǎn)品體驗鏈接,并對用戶量和使用量進行說明。
下載圖片接口
- wx.downloadImage({
- serverId: '', // 需要下載的圖片的服務(wù)器端ID,由uploadImage接口獲得
- isShowProgressTips: 1, // 默認(rèn)為1,顯示進度提示
- success: function (res) {
- var localId = res.localId; // 返回圖片下載后的本地ID
- }
- });
音頻接口
開始錄音接口
- wx.startRecord();
停止錄音接口
- wx.stopRecord({
- success: function (res) {
- var localId = res.localId;
- }
- });
監(jiān)聽錄音自動停止接口
- wx.onVoiceRecordEnd({
- // 錄音時間超過一分鐘沒有停止的時候會執(zhí)行 complete 回調(diào)
- complete: function (res) {
- var localId = res.localId;
- }
- });
播放語音接口
- wx.playVoice({
- localId: '' // 需要播放的音頻的本地ID,由stopRecord接口獲得
- });
暫停播放接口
- wx.pauseVoice({
- localId: '' // 需要暫停的音頻的本地ID,由stopRecord接口獲得
- });
停止播放接口
- wx.stopVoice({
- localId: '' // 需要停止的音頻的本地ID,由stopRecord接口獲得
- });
監(jiān)聽語音播放完畢接口
- wx.onVoicePlayEnd({
- success: function (res) {
- var localId = res.localId; // 返回音頻的本地ID
- }
- });
上傳語音接口
- wx.uploadVoice({
- localId: '', // 需要上傳的音頻的本地ID,由stopRecord接口獲得
- isShowProgressTips: 1, // 默認(rèn)為1,顯示進度提示
- success: function (res) {
- var serverId = res.serverId; // 返回音頻的服務(wù)器端ID
- }
- });
備注:上傳語音有效期3天,可用微信多媒體接口下載語音到自己的服務(wù)器,此處獲得的 serverId 即 media_id,參考文檔 ../12/58bfcfabbd501c7cd77c19bd9cfa8354.html 目前多媒體文件下載接口的頻率限制為10000次,如需要調(diào)高頻率,請郵件weixin-open@qq.com,郵件主題為【申請多媒體接口調(diào)用量】,請對你的項目進行簡單描述,附上產(chǎn)品體驗鏈接,并對用戶量和使用量進行說明。
下載語音接口
- wx.downloadVoice({
- serverId: '', // 需要下載的音頻的服務(wù)器端ID,由uploadVoice接口獲得
- isShowProgressTips: 1, // 默認(rèn)為1,顯示進度提示
- success: function (res) {
- var localId = res.localId; // 返回音頻的本地ID
- }
- });
智能接口
識別音頻并返回識別結(jié)果接口
- wx.translateVoice({
- localId: '', // 需要識別的音頻的本地Id,由錄音相關(guān)接口獲得
- isShowProgressTips: 1, // 默認(rèn)為1,顯示進度提示
- success: function (res) {
- alert(res.translateResult); // 語音識別的結(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, // 緯度,浮點數(shù),范圍為90 ~ -90
- longitude: 0, // 經(jīng)度,浮點數(shù),范圍為180 ~ -180。
- name: '', // 位置名
- address: '', // 地址詳情說明
- scale: 1, // 地圖縮放級別,整形值,范圍從1~28。默認(rèn)為最大
- infoUrl: '' // 在查看位置界面底部顯示的超鏈接,可點擊跳轉(zhuǎn)
- });
獲取地理位置接口
- wx.getLocation({
- success: function (res) {
- var latitude = res.latitude; // 緯度,浮點數(shù),范圍為90 ~ -90
- var longitude = res.longitude; // 經(jīng)度,浮點數(shù),范圍為180 ~ -180。
- var speed = res.speed; // 速度,以米/每秒計
- var accuracy = res.accuracy; // 位置精度
- }
- });