• API 列表
  • 基礎(chǔ)
  • 路由
  • 網(wǎng)絡(luò)
  • 界面
  • 數(shù)據(jù)存儲
  • AI
  • 媒體
  • 位置
  • 畫布
  • 文件
  • 設(shè)備
  • 第三方平臺
  • 開放接口
  • 用戶接口
  • 服務(wù)端 API
  • 廣告 API

API 列表

智能小程序 API ，為開發(fā)者提供了百度 App 豐富的端能力，幫助開發(fā)者開發(fā)具有原生 App 體驗的小程序。
本文匯總了智能小程序提供的所有 API ，具體 API 信息可參閱對應(yīng)文檔。API 錯誤碼請參考錯誤碼列表。

十載的鄒平網(wǎng)站建設(shè)經(jīng)驗，針對設(shè)計、前端、開發(fā)、售后、文案、推廣等六對一服務(wù)，響應(yīng)快，48小時及時工作處理。網(wǎng)絡(luò)營銷推廣的優(yōu)勢是能夠根據(jù)用戶設(shè)備顯示端的尺寸不同，自動調(diào)整鄒平建站的顯示方式，使網(wǎng)站能夠適用不同顯示終端，在瀏覽器中調(diào)整網(wǎng)站的寬度，無論在任何一種瀏覽器上瀏覽網(wǎng)站，都能展現(xiàn)優(yōu)雅布局與設(shè)計，從而大程度地提升瀏覽體驗。創(chuàng)新互聯(lián)從事“鄒平網(wǎng)站設(shè)計”,“鄒平網(wǎng)站推廣”以來，每個客戶項目都認真落實執(zhí)行。

基礎(chǔ)

API 名稱	解釋
swan.canIUse	判斷智能小程序的 API 、回調(diào)、參數(shù)、組件等是否在當前版本和當前系統(tǒng)下可用
swan.onPageNotFound	監(jiān)聽小程序要打開的頁面不存在事件。該事件與 App.onPageNotFound 的回調(diào)時機一致
swan.onAppShow	監(jiān)聽小程序切前臺事件。該事件與 App.onShow 的回調(diào)參數(shù)一致
swan.onAppHide	監(jiān)聽小程序切后臺事件。該事件與 App.onHide 的回調(diào)時機一致
swan.onError	監(jiān)聽小程序錯誤事件。如腳本錯誤或 API 調(diào)用報錯等。該事件與 App.onError 的回調(diào)時機與參數(shù)一致
swan.offPageNotFound	取消監(jiān)聽小程序要打開的頁面不存在事件
swan.offAppShow	取消監(jiān)聽小程序切前臺事件
swan.offAppHide	取消監(jiān)聽小程序切后臺事件
swan.offError	取消監(jiān)聽小程序錯誤事件
swan.getURLQuery	獲取當前頁面的 URL query 對象值。在當前頁面的 URL Query 更新后，只能通過此 API 主動獲取當前頁面最新的 URL query
swan.setURLQuery	設(shè)置當前頁面的 URL query
swan.getUpdateManager	獲取全局唯一的版本更新管理器，用于管理小程序更新
clearInterval	取消由 setInterval 設(shè)置的定時器
clearTimeout	取消由 setTimeout 設(shè)置的定時器
setInterval	設(shè)定一個定時器，按照指定的周期（以毫秒計）來執(zhí)行注冊的回調(diào)函數(shù)
setTimeout	設(shè)定一個定時器，在定時到期以后執(zhí)行注冊的回調(diào)函數(shù)
swan.setEnableDebug	設(shè)置是否打開調(diào)試開關(guān)，此開關(guān)對正式版也能生效

路由

API 名稱	解釋
swan.switchTab	跳轉(zhuǎn)到 tabBar 頁面，并關(guān)閉其他所有非 tabBar 頁面
swan.reLaunch	關(guān)閉所有頁面，打開到應(yīng)用內(nèi)的某個頁面
swan.redirectTo	關(guān)閉當前頁面，跳轉(zhuǎn)到應(yīng)用內(nèi)的某個頁面
swan.navigateTo	保留當前頁面，跳轉(zhuǎn)到應(yīng)用內(nèi)的某個頁面，但是不能跳轉(zhuǎn)到 tabbar 頁面，使用 swan.navigateBack 可以返回到原頁面
swan.navigateBack	關(guān)閉當前頁面，返回上一頁面或多級頁面

網(wǎng)絡(luò)

API 名稱	解釋
swan.request	發(fā)起網(wǎng)絡(luò)請求
swan.uploadFile	將本地資源上傳到開發(fā)者服務(wù)器，客戶端發(fā)起一個 HTTPS POST 請求，其中 content-type 為 multipart/form-data 如頁面通過 swan.chooseImage 等接口獲取到一個本地資源的臨時文件路徑后，可通過此接口將本地資源上傳到指定服務(wù)器
swan.downloadFile	下載文件資源到本地，客戶端直接發(fā)起一個 HTTP GET 請求，返回文件的本地臨時路徑
swan.connectSocket	創(chuàng)建一個 WebSocket 連接
swan.onSocketOpen	監(jiān)聽 WebSocket 連接打開事件
swan.onSocketError	監(jiān)聽 WebSocket 錯誤
swan.sendSocketMessage	通過 WebSocket 連接發(fā)送數(shù)據(jù)，需要先調(diào)用 swan.connectSocket ，并在 swan.onSocketOpen 回調(diào)之后才能發(fā)送
swan.onSocketMessage	監(jiān)聽 WebSocket 接受到服務(wù)器的消息事件
swan.closeSocket	關(guān)閉 WebSocket 連接，須在 WebSocket 打開期間調(diào)用 swan.closeSocket 才能關(guān)閉
swan.onSocketClose	監(jiān)聽 WebSocket 關(guān)閉
SocketTask	WebSocket 任務(wù)，可通過 swan.connectSocket 接口創(chuàng)建返回

界面

API 名稱	解釋
swan.showToast	顯示消息提示框
swan.showLoading	顯示 loading 提示框, 需主動調(diào)用 swan.hideLoading 才能關(guān)閉提示框
swan.showModal	顯示模態(tài)彈窗
swan.showActionSheet	顯示操作菜單
swan.hideToast	隱藏消息提示框
swan.hideLoading	隱藏 loading 提示框
swan.showNavigationBarLoading	該方法在當前頁面顯示導航條加載動畫
swan.setNavigationBarTitle	動態(tài)設(shè)置當前頁面的標題
swan.setNavigationBarColor	動態(tài)設(shè)置當前頁面導航條的顏色
swan.hideNavigationBarLoading	隱藏導航條加載動畫
swan.showTabBar	顯示 tabBar
swan.setTabBarItem	動態(tài)設(shè)置 tabBar 某一項的內(nèi)容
swan.setTabBarStyle	動態(tài)設(shè)置 tabBar 的整體樣式
swan.setTabBarBadge	為 tabBar 某一項的右上角添加文本
swan.showTabBarRedDot	顯示 tabBar 某一項的右上角的紅點
swan.hideTabBar	隱藏 tabBar
swan.removeTabBarBadge	移除 tabBar 某一項右上角的文本
swan.hideTabBarRedDot	隱藏 tabBar 某一項的右上角的紅點
swan.showFavoriteGuide	支持在小程序內(nèi)調(diào)起關(guān)注小程序引導組件，引導用戶關(guān)注小程序。引導組件設(shè)計文檔詳見：關(guān)注小程序引導
swan.pageScrollTo	將頁面滾動到目標位置（可以設(shè)置滾動動畫時長）
onPullDownRefresh	詳情參見頁面事件處理函數(shù)
swan.startPullDownRefresh	開始下拉刷新，調(diào)用后觸發(fā)下拉刷新動畫，效果與用戶手動下拉刷新一致
swan.stopPullDownRefresh	停止當前頁面下拉刷新
swan.setBackgroundColor	設(shè)置窗口的背景顏色
swan.setBackgroundTextStyle	設(shè)置窗口下拉背景 loading 樣式
swan.createAnimation	創(chuàng)建一個動畫實例 animation
animation	動畫實例可以調(diào)用以下方法來描述動畫，調(diào)用結(jié)束后會返回自身，支持鏈式調(diào)用的寫法
swan.nextTick	延遲一部分操作到下一個時間片再執(zhí)行（類似于 setTimeout）
swan.getMenuButtonBoundingClientRect	獲取菜單按鈕（右上角膠囊按鈕）的布局位置信息。坐標信息以屏幕左上角為原點
swan.createIntersectionObserver	創(chuàng)建并返回一個 IntersectionObserver 對象實例。在自定義組件中，可以使用this.createIntersectionObserver([options])來代替
IntersectionObserver	IntersectionObserver 對象，用于推斷某些節(jié)點是否可以被用戶看見、有多大比例可以被用戶看見
IntersectionObserver.disconnect	停止監(jiān)聽?；卣{(diào)函數(shù)將不再觸發(fā)
IntersectionObserver.observe	指定目標節(jié)點并開始監(jiān)聽相交狀態(tài)變化情況
IntersectionObserver.relativeTo	使用選擇器指定一個節(jié)點，作為參照區(qū)域之一
IntersectionObserver.relativeToViewport	指定頁面顯示區(qū)域作為參照區(qū)域之一
swan.createSelectorQuery	返回一個 SelectorQuery 對象實例?？梢栽谶@個實例上使用 select 等方法選擇節(jié)點，并使用 boundingClientRect 等方法選擇需要查詢的信息
selectorQuery	選擇器
selectorQuery.exec	執(zhí)行所有的請求，請求結(jié)果按請求次序構(gòu)成數(shù)組，在 callback 的第一個參數(shù)中返回
selectorQuery.in	將選擇器的選取范圍更改為自定義組件 component 內(nèi)（初始時，選擇器僅選取頁面范圍的節(jié)點，不會選取任何自定義組件中的節(jié)點）
selectorQuery.select	在當前頁面下選擇第一個匹配選擇器 selector 的節(jié)點，返回一個 NodesRef 對象實例，可以用于獲取節(jié)點信息
selectorQuery.selectAll	在當前頁面下選擇匹配選擇器 selector 的節(jié)點，返回一個 NodesRef 對象實例。 與 selectorQuery.select(selector) 不同的是，它選擇所有匹配選擇器的節(jié)點
selectorQuery.selectViewport	選擇顯示區(qū)域，可用于獲取顯示區(qū)域的尺寸、滾動位置等信息，返回一個 NodesRef 對象實例
nodesRef	節(jié)點信息
nodesRef.boundingClientRect	添加節(jié)點的布局位置的查詢請求，相對于顯示區(qū)域（單位：像素）。其功能類似于 DOM 的 getBoundingClientRect。返回值是 nodesRef 對應(yīng)的 selectorQuery
nodesRef.fields	獲取節(jié)點的相關(guān)信息，需要獲取的字段在 fields 中指定。返回值是 nodesRef 對應(yīng)的 selectorQuery
nodesRef.scrollOffset	添加節(jié)點的滾動位置查詢請求（單位：像素）。節(jié)點必須是 scroll-view 或者 viewport 。返回值是 nodesRef 對應(yīng)的 selectorQuery

數(shù)據(jù)存儲

API 名稱	解釋
swan.setStorage	將數(shù)據(jù)存儲在本地緩存指定的 key 中。如果之前存在同名 key ，會覆蓋掉原來該 key 對應(yīng)的內(nèi)容。這是一個異步接口
swan.setStorageSync	將數(shù)據(jù)存儲在本地緩存中指定的 key 中。如果之前存在同名 key ，會覆蓋掉原來該 key 對應(yīng)的內(nèi)容。這是一個同步接口
swan.getStorage	從本地緩存中異步獲取指定 key 對應(yīng)的內(nèi)容
swan.getStorageSync	從本地緩存中同步獲取指定 key 對應(yīng)的內(nèi)容
swan.getStorageInfo	異步獲取當前 storage 的相關(guān)信息
swan.getStorageInfoSync	同步獲取當前 storage 的相關(guān)信息
swan.removeStorage	從本地緩存中異步移除指定 key
swan.removeStorageSync	從本地緩存中同步移除指定 key
swan.clearStorage	清理本地數(shù)據(jù)緩存
swan.clearStorageSync	同步清理本地數(shù)據(jù)緩存

AI

API 名稱	解釋
swan.ai.ocrIdCard	用戶向服務(wù)請求識別身份證，身份證識別包括正面和背面
swan.ai.ocrBankCard	識別銀行卡并返回卡號、發(fā)卡行和卡片類型
swan.ai.ocrDrivingLicense	對機動車駕駛證所有關(guān)鍵字段進行識別
swan.ai.ocrVehicleLicense	對機動車行駛證正本所有關(guān)鍵字段進行識別
swan.ai.textReview	運用業(yè)界領(lǐng)先的深度學習技術(shù)，判斷一段文本內(nèi)容是否符合網(wǎng)絡(luò)發(fā)文規(guī)范，實現(xiàn)自動化、智能化的文本審核
swan.ai.nlpLexerCustom	詞法分析，提供分詞、詞性標注、專名識別三大功能
swan.ai.advancedGeneralIdentify	通用物體及場景識別，即對于輸入的一張圖片（可正常解碼，且長寬比適宜），輸出圖片中的多個物體及場景標簽
swan.ai.animalClassify	該請求用于識別一張圖片，即對于輸入的一張圖片（可正常解碼，且長寬比較合適），輸出動物識別結(jié)果
swan.ai.carClassify	用于檢測一張車輛圖片的具體車型，即對于輸入的一張圖片（可正常解碼，且長寬比適宜），輸出圖片的車輛品牌及型號、顏色及年份、位置信息
swan.ai.dishClassify	用于菜品識別，即對于輸入的一張圖片（可正常解碼，且長寬比適宜），輸出圖片的菜品名稱、卡路里信息、置信度
swan.ai.logoClassify	用于檢測和識別圖片中的品牌 LOGO 信息。即對于輸入的一張圖片（可正常解碼，且長寬比適宜），輸出圖片中 LOGO 的名稱、位置和置信度。 當效果欠佳時，可以建立子庫（在控制臺創(chuàng)建應(yīng)用并申請建庫）并通過調(diào)用 logo 入口接口完成自定義 logo 入庫，提高識別效果
swan.ai.objectDetectIdentify	用戶向服務(wù)請求檢測圖像中的主體位置
swan.ai.plantClassify	該請求用于識別一張圖片，即對于輸入的一張圖片（可正常解碼，且長寬比較合適），輸出植物識別結(jié)果
swan.ai.imageAudit	自定義圖像審核
swan.ai.getVoiceRecognizer	獲取全局唯一的語音識別器 voiceRecognizer
swan.ai.textToAudio	將文本轉(zhuǎn)換為可以播放的 mp3 文件
swan.ai.faceDetect	人臉檢測，檢測圖片中的人臉并標記出相應(yīng)的信息位置，同時可以展示出人臉的關(guān)鍵信息和屬性信息，比如年齡，性別等
swan.ai.faceMatch	人臉對比，支持兩張人臉圖片的相似度對比，圖片類型可以為：生活照，證件照，身份證芯片照或者帶網(wǎng)紋照
swan.ai.faceSearch	人臉搜索，傳入人臉圖片，支持在指定人臉圖片集合中，找到與傳入圖片中人臉最為相似的圖片
swan.ai.facePersonVerify	公安驗證，基于姓名和身份證號，調(diào)取公民身份證小圖（源自公安系統(tǒng)），將當前獲取的人臉圖片，與此證件小圖進行對比，得出比對分數(shù)
swan.ai.facePersonIdmatch	身份證和名字對比，驗證用戶輸入的身份證號碼和姓名是否匹配，用于判斷用戶信息是否真實
swan.ai.faceLivenessSessioncode	H5 活體檢測-語音校驗碼，為防止用戶提交非當前操作的視頻，在錄制視頻時，隨機分配一個數(shù)字，用戶需要讀出這個數(shù)字，在后續(xù)識別時校驗，以判斷視頻是否為現(xiàn)場錄制

媒體

API 名稱	解釋
swan.previewImage	預(yù)覽圖片
swan.getImageInfo	獲取圖片信息
swan.saveImageToPhotosAlbum	保存圖片到系統(tǒng)相冊，需要用戶授權(quán)
swan.chooseImage	從本地相冊選擇圖片或使用相機拍照
swan.chooseAlbum	打開本地相冊，相冊內(nèi)可以同時包含圖片和視頻
swan.compressImage	壓縮圖片接口
swan.createCameraContext	創(chuàng)建并返回 camera 上下文 cameraContext 對象，cameraContext 與頁面的 camera 組件綁定，一個頁面只能有一個 camera，通過它可以操作對應(yīng)的組件
swan.createARCameraContext	創(chuàng)建并返回 ar-camera 上下文 ARCameraContext 對象，ARCameraContext 與頁面的 ar-camera 組件綁定，一個頁面只能有一個 ar-camera，通過它可以操作對應(yīng)的組件
swan.getBackgroundAudioManager	獲取全局唯一的背景音頻管理器 backgroundAudioManager
swan.createInnerAudioContext	創(chuàng)建并返回內(nèi)部 audio 上下文 innerAudioContext 對象
swan.setInnerAudioOption	對 innerAudioContext 進行小程序內(nèi)部的全局設(shè)置
swan.getRecorderManager	獲取全局唯一的錄音管理器 recorderManager
swan.getAvailableAudioSources	獲取當前支持的音頻輸入源
swan.chooseVideo	拍攝視頻或從手機相冊中選視頻，返回視頻的臨時文件路徑
swan.saveVideoToPhotosAlbum	保存視頻到系統(tǒng)相冊。需要用戶授權(quán)
swan.createVideoContext	創(chuàng)建并返回 video 上下文 videoContext 對象。通過 videoId 跟一個 video 組件綁定，通過它可以操作一個 video 組件
swan.createAnimationVideo	創(chuàng)建并返回 animation-video 上下文 animationVideo 對象。通過 animationVideoId 跟一個 animation-video 組件綁定，通過它可以操作一個 animation-video 組件
swan.createLivePlayerContext	操作對應(yīng)的 live-player 組件。 創(chuàng)建并返回 live-player 上下文 LivePlayerContext 對象
swan.createRtcRoomContext	操作對應(yīng)的 rtc-room 組件。 創(chuàng)建并返回 rtc-room 上下文 createRtcRoomContext 對象

位置

API 名稱	解釋
swan.getLocation	獲取當前的地理位置、速度。當用戶離開智能小程序后，此接口無法調(diào)用
swan.openLocation	使用宿主 APP 內(nèi)置地圖查看位置
swan.chooseLocation	打開地圖選擇位置。需要用戶授權(quán) scope.userLocation
swan.startLocationUpdate	開啟小程序進入前臺時接收位置消息
swan.onLocationChange	監(jiān)聽實時地理位置變化事件，需結(jié)合 swan.startLocationUpdate 使用
swan.offLocationChange	取消監(jiān)聽實時地理位置變化事件
swan.stopLocationUpdate	關(guān)閉監(jiān)聽實時位置變化
swan.createMapContext	創(chuàng)建并返回 map 上下文 mapContext 對象。在自定義組件下，第二個參數(shù)傳入組件實例 this ，以操作組件內(nèi) map 組件。mapContext 通過 mapId 跟一個組件綁定，通過它可以操作對應(yīng)的組件

畫布

API 名稱	解釋
swan.createCanvasContext	在 Page 中，推薦使用this.createCanvasContext(canvasId)，進行繪圖上下文的創(chuàng)建。也可使用swan.createCanvasContext(canvasId)，但使用swan.createCanvasContext(canvasId)進行創(chuàng)建時，并非在執(zhí)行所在的 Page 對象中使用 canvasId 進行查找，而是在用戶當前可視的 Page 中使用 canvasId 進行查找
swan.canvasPutImageData	將像素數(shù)據(jù)繪制到畫布的方法。在自定義組件下，第二個參數(shù)傳入自定義組件實例 this ，以操作組件內(nèi) canvas 組件
swan.canvasGetImageData	返回一個數(shù)組，用來描述 canvas 區(qū)域隱含的像素數(shù)據(jù)。在自定義組件下，第二個參數(shù)傳入自定義組件實例 this ，以操作組件內(nèi) canvas 組件
swan.canvasToTempFilePath	把當前畫布指定區(qū)域的內(nèi)容導出生成指定大小的圖片，并返回文件路徑。在自定義組件下，第二個參數(shù)傳入組件實例 this ，以操作組件內(nèi) canvas 組件
canvasContext	繪圖上下文
canvasContext.setFillStyle	設(shè)置填充色
canvasContext.setStrokeStyle	設(shè)置邊框顏色
canvasContext.setShadow	設(shè)置陰影樣式
canvasContext.createLinearGradient	創(chuàng)建一個線性的漸變顏色
canvasContext.createCircularGradient	創(chuàng)建一個圓形的漸變顏色
canvasContext.addColorStop	創(chuàng)建一個顏色的漸變點
canvasContext.setLineWidth	設(shè)置線條的寬度
canvasContext.setLineCap	設(shè)置線條的端點樣式
canvasContext.setLineJoin	設(shè)置線條的交點樣式
canvasContext.setLineDash	設(shè)置線條的寬度
canvasContext.setMiterLimit	設(shè)置最大斜接長度，斜接長度指的是在兩條線交匯處內(nèi)角和外角之間的距離，當 setLineJoin() 為 miter 時才有效，超過最大傾斜長度的，連接處將以 lineJoin 為 bevel 來顯示
canvasContext.rect	創(chuàng)建一個矩形
canvasContext.fillRect	填充一個矩形
canvasContext.strokeRect	畫一個矩形（非填充）
canvasContext.clearRect	清除畫布上在該矩形區(qū)域內(nèi)的內(nèi)容
canvasContext.fill	對當前路徑中的內(nèi)容進行填充。默認的填充色為黑色
canvasContext.stroke	畫出當前路徑的邊框。默認顏色為黑色
canvasContext.beginPath	開始創(chuàng)建一個路徑，需要調(diào)用 fill() 方法或者 stroke() 方法才會使用路徑進行填充或描邊
canvasContext.closePath	關(guān)閉一個路徑
canvasContext.moveTo	把路徑移動到畫布中的指定點，不創(chuàng)建線條
canvasContext.lineTo	lineTo 方法增加一個新點，然后創(chuàng)建一條從上次指定點到目標點的線
canvasContext.arc	畫一條弧線
canvasContext.scale	在調(diào)用 scale 方法后，之后創(chuàng)建的路徑其橫縱坐標會被縮放。多次調(diào)用 scale ，倍數(shù)會相乘
canvasContext.rotate	以原點為中心，原點可以用 translate() 方法修改。順時針旋轉(zhuǎn)當前坐標軸。多次調(diào)用 rotate ，旋轉(zhuǎn)的角度會疊加
canvasContext.translate	對當前坐標系的原點 (0, 0) 進行變換，默認的坐標系原點為頁面左上角
canvasContext.clip	clip() 方法從原始畫布中剪切任意形狀和尺寸。一旦剪切了某個區(qū)域，則所有之后的繪圖都會被限制在被剪切的區(qū)域內(nèi)（不能訪問畫布上的其他區(qū)域）?？梢栽谑褂?clip() 方法前通過使用 save() 方法對當前畫布區(qū)域進行保存，并在以后的任意時間對其進行恢復（通過 restore() 方法）
canvasContext.setFontSize	設(shè)置字體的字號
canvasContext.fillText	在畫布上繪制被填充的文本
canvasContext.setTextAlign	用于設(shè)置文字的對齊
canvasContext.setTextBaseline	用于設(shè)置文字的水平對齊。
canvasContext.drawImage	繪制圖像到畫布
canvasContext.setGlobalAlpha	設(shè)置全局畫筆透明度
canvasContext.measureText	測量文本尺寸信息，目前僅返回文本寬度，同步接口
canvasContext.strokeText	給定的 (x, y) 位置繪制文本描邊的方法
canvasContext.setLineDashOffset	設(shè)置虛線偏移量的屬性
canvasContext.bezierCurveTo	創(chuàng)建三次方貝塞爾曲線路徑
canvasContext.quadraticCurveTo	創(chuàng)建二次貝塞爾曲線路徑
canvasContext.save	保存當前的繪圖上下文
canvasContext.restore	恢復之前保存的繪圖上下文
canvasContext.draw	將之前在繪圖上下文中的描述（路徑、變形、樣式）畫到 canvas 中
canvasContext.font	設(shè)置當前字體樣式的屬性
canvasContext.setTransform	使用矩陣重新設(shè)置（覆蓋）當前變換的方法

文件

API 名稱	解釋
swan.saveFile	保存文件到本地
swan.getFileInfo	獲取文件信息
swan.getSavedFileList	獲取本地已保存的文件列表
swan.getSavedFileInfo	獲取本地文件的文件信息。此接口只能用于獲取已保存到本地的文件，若需要獲取臨時文件信息，請使用 getFileInfo 接口
swan.removeSavedFile	刪除本地存儲的文件
swan.openDocument	新開頁面打開文檔，支持格式：doc、xls、ppt、pdf、docx、xlsx、pptx
swan.getFileSystemManager	獲取全局唯一的文件管理器對象

設(shè)備

API 名稱	解釋
swan.getSystemInfo	獲取系統(tǒng)信息
swan.getSystemInfoSync	獲取系統(tǒng)信息同步接口
swan.getEnvInfoSync	獲取運行環(huán)境信息同步接口
swan.getNetworkType	獲取網(wǎng)絡(luò)類型
swan.onNetworkStatusChange	監(jiān)聽網(wǎng)絡(luò)狀態(tài)變化
swan.setScreenBrightness	設(shè)置屏幕亮度
swan.getScreenBrightness	獲取屏幕亮度
swan.setKeepScreenOn	設(shè)置是否保持常亮狀態(tài)。僅在當前智能小程序生效，離開智能小程序后設(shè)置失效
swan.makePhoneCall	撥打電話
swan.vibrateLong	使手機發(fā)生較長時間的振動（400ms）
swan.vibrateShort	使手機發(fā)生較短時間的振動（15ms），僅在 iPhone 7/7 Plus 以上及 Android 機型生效
swan.setClipboardData	設(shè)置系統(tǒng)剪貼板的內(nèi)容
swan.getClipboardData	獲取系統(tǒng)剪貼板內(nèi)容
swan.scanCode	調(diào)起客戶端掃碼界面，掃碼成功后返回對應(yīng)的結(jié)果
swan.onAccelerometerChange	監(jiān)聽加速度數(shù)據(jù)，頻率：5 次/秒，接口調(diào)用后會自動開始監(jiān)聽，可使用 swan.stopAccelerometer 停止監(jiān)聽
swan.startAccelerometer	開始監(jiān)聽加速度數(shù)據(jù)
swan.stopAccelerometer	停止監(jiān)聽加速度數(shù)據(jù)
swan.onCompassChange	監(jiān)聽羅盤數(shù)據(jù)，頻率：5 次/秒，接口調(diào)用后會自動開始監(jiān)聽，可使用 swan.stopCompass 停止監(jiān)聽
swan.startCompass	開始監(jiān)聽羅盤數(shù)據(jù)
swan.stopCompass	停止監(jiān)聽羅盤數(shù)據(jù)
swan.onDeviceMotionChange	監(jiān)聽設(shè)備方向變化事件。頻率根據(jù) swan.startDeviceMotionListening 的 interval 參數(shù)。可以使用 swan.stopDeviceMotionListening 停止監(jiān)聽
swan.startDeviceMotionListening	開始監(jiān)聽設(shè)備方向的變化
swan.stopDeviceMotionListening	停止監(jiān)聽設(shè)備方向的變化
swan.onMemoryWarning	監(jiān)聽內(nèi)存不足的告警事件，Android 下有告警等級劃分，只有 LOW 和 CRITICAL 會回調(diào)開發(fā)者；iOS 無等級劃分
swan.addPhoneContact	調(diào)用后，用戶可以選擇將聯(lián)系人數(shù)據(jù)以“新增聯(lián)系人”或“添加到已有聯(lián)系人”的方式，寫入手機系統(tǒng)通訊錄，完成手機通訊錄聯(lián)系人和聯(lián)系方式的增加
swan.getBatteryInfo	支持在小程序內(nèi)獲取當前設(shè)備電量
swan.getBatteryInfoSync	獲取當前設(shè)備電量同步接口，iOS 系統(tǒng)不可用
swan.onUserCaptureScreen	監(jiān)聽用戶主動截屏事件，用戶使用系統(tǒng)截屏按鍵截屏時觸發(fā)此事件
swan.addEventOnCalendar	向系統(tǒng)日歷寫入一個活動，之后在設(shè)定的時間提醒
swan.deleteEventOnCalendar	刪除日歷上的某個活動
swan.onKeyboardHeightChange	監(jiān)聽鍵盤高度變化
swan.offKeyboardHeightChange	取消監(jiān)聽鍵盤高度變化

第三方平臺

API 名稱	解釋
swan.getExtConfig	獲取第三方平臺自定義的數(shù)據(jù)字段
swan.getExtConfigSync	swan.getExtConfig 的同步版本

開放接口

API 名稱	解釋
swan.getLoginCode	獲取宿主 App 登錄憑證（Authorization Code）
swan.checkSession	通過上述接口獲得的用戶登錄態(tài)擁有一定的時效性，用戶越久未使用智能小程序，用戶登錄態(tài)越有可能失效；反之如果用戶一直在使用智能小程序，則用戶登錄態(tài)一直保持有效。具體時效邏輯由宿主維護，對開發(fā)者透明。開發(fā)者可以調(diào)用 swan.checkSession 接口 檢測當前用戶登錄態(tài)是否有效，登錄態(tài)過期的開發(fā)者可以在已經(jīng)登錄的情況下再調(diào)用 swan.getLoginCode 獲取新的用戶登錄態(tài)
swan.isLoginSync	宿主 APP 登錄狀態(tài)
swan.authorize	提前向用戶發(fā)起授權(quán)請求。調(diào)用后會立刻彈窗詢問用戶是否同意授權(quán)智能小程序使用某項功能或獲取用戶的某些數(shù)據(jù)，但不會實際調(diào)用對應(yīng)接口。如果用戶之前已經(jīng)同意授權(quán)，則不會出現(xiàn)彈窗，直接返回成功
swan.openSetting	調(diào)起客戶端智能小程序設(shè)置界面，返回用戶設(shè)置的操作結(jié)果
swan.getSetting	獲取用戶的當前設(shè)置
swan.requestPolymerPayment	百度收銀臺，聚合了主流的百度錢包、微信、支付寶、網(wǎng)銀等多種支付方式，方便開發(fā)者一站式快速接入多種支付渠道，讓百度用戶能在智能小程序場景下，直接完成支付、交易閉環(huán)，提升用戶支付體驗的同時，提高智能小程序的訂單轉(zhuǎn)化率
swan.setPageInfo	智能小程序可接入百度搜索和宿主 App 信息流，swan.setPageInfo 負責為小程序設(shè)置各類頁面基礎(chǔ)信息，包括標題、關(guān)鍵字、頁面描述以及圖片信息、視頻信息等。開發(fā)者為智能小程序設(shè)置完備的頁面基礎(chǔ)信息，有助于智能小程序在搜索引擎和信息流中得到更加有效的展示和分發(fā)
swan.setMetaDescription	不推薦使用
swan.setMetaKeywords	不推薦使用
swan.setDocumentTitle	不推薦使用
swan.loadSubPackage	提前下載好子包的資源，目錄結(jié)構(gòu)配置參考分包預(yù)下載
swan.reportAnalytics	自定義分析數(shù)據(jù)上報接口。使用前，需要在小程序管理后臺自定義分析中新建事件，配置好事件名與字段
swan.getSystemRiskInfo	獲取用于得到風控信息的加密信息對象
swan.subscribeService	小程序消息訂閱服務(wù)：取消訂閱和查詢訂閱
swan.insertBookshelf	添加內(nèi)容到宿主書架（需宿主支持書架入口）
swan.deleteBookshelf	刪除書架中的內(nèi)容（需宿主支持書架入口）
swan.queryBookshelf	查詢宿主書架的相關(guān)內(nèi)容（需宿主支持書架入口）
swan.updateBookshelfReadTime	更新已加入宿主書架的內(nèi)容的閱讀時間（需宿主支持書架入口）
swan.navigateToBookshelf	跳轉(zhuǎn)到宿主（需宿主支持書架入口）
swan.openBdboxWebview	小程序跳轉(zhuǎn)百度 App 內(nèi)特定頁面。

用戶接口

API 名稱	解釋
swan.getSwanId	獲取 swanid
swan.getUserInfo	獲取用戶信息，首次使用的用戶會彈出授權(quán)提示窗，若用戶同意，則會返回用戶的真實數(shù)據(jù)；若用戶未登錄或者拒絕授權(quán)，會返回默認用戶“百度網(wǎng)友”及默認的頭像地址
onShareAppMessage	詳情參見頁面事件處理函數(shù)
swan.openShare	調(diào)起分享面板
swan.shareFile	支持調(diào)起系統(tǒng)分享面板將文件分享到其他 APP
swan.navigateToSmartProgram	打開另一個小程序
swan.navigateBackSmartProgram	返回到上一個小程序
swan.chooseAddress	調(diào)起用戶編輯收貨地址原生界面，并在編輯完成后返回用戶選擇的地址，需要用戶授權(quán) scope.address
swan.chooseInvoiceTitle	選擇用戶的發(fā)票抬頭，需要用戶授權(quán) scope.invoiceTitle
swan.openCommunityEditor	調(diào)起原生全屏內(nèi)容發(fā)布器，并支持開發(fā)者配置發(fā)布器展示模塊
swan.closeCommunityEditor	關(guān)閉原生全屏內(nèi)容發(fā)布器
swan.openReplyEditor	調(diào)起原生半屏內(nèi)容發(fā)布器，并支持開發(fā)者配置發(fā)布器展示模塊
swan.closeReplyEditor	關(guān)閉原生半屏內(nèi)容發(fā)布器

服務(wù)端 API

API 名稱	解釋
submitresource	提交物料資源
deleteresource	下線物料資源
submitsitemap	提交 sitemap
deletesitemap	刪除 sitemap
getTemplateLibraryList	獲取帳號下已存在的模板列表
getTemplateLibraryById	獲取模板庫某個模板標題下關(guān)鍵詞庫
addTemplate	組合模板并添加至帳號下的個人模板庫
getTemplateList	獲取帳號下已存在的模板列表
deleteTemplate	刪除帳號下的某個模板
sendTemplateMessage	推送模板消息
detectrisk	檢測用戶是否是作弊用戶
get	獲取小程序二維碼，適用于需要的碼數(shù)量較少的業(yè)務(wù)場景。通過該接口生成的二維碼，永久有效，有數(shù)量限制
getunlimited	獲取小程序二維碼，適用于需要的碼數(shù)量較多的業(yè)務(wù)場景。通過該接口生成的二維碼，永久有效，無數(shù)量限制
submitsku	提交服務(wù)資源
deletesku	刪除服務(wù)資源

廣告 API

API 名稱	解釋
swan.createRewardedVideoAd	創(chuàng)建并返回激勵視頻廣告對象。

當前文章：創(chuàng)新互聯(lián)百度小程序教程：API列表
網(wǎng)頁地址：http://www.5511xx.com/article/cdigide.html