小程序开发指南

能力概述

我的收藏

抖音开放平台开放能力是平台提供给开发者接入、使用、开展业务的各项 API、SDK、组件等。抖音小程序依托抖音、头条等生态产品，为小程序开发者提供了授权、挂载、消息及客服、关注、直播间、支付、行业以及通用的基础能力和运营能力等一系列能力，在符合平台规则的前提下，开发者可以通过达到特定要求申请获取使用平台能力，从而完成小程序的开发、设计，实现在抖音生态内的业务开展。

基于能力获取条件的不同，抖音开放平台能力分为基础能力、进阶能力、高级能力三种不同类型：

能力类型	描述
基础能力	创建小程序后，通常默认获得的能力，一般用于实现小程序的基本功能以及一些运营、行业能力，例如页面导航的设置、图片视频操作、数据缓存设置等，另外也包括小程序挂载、IM 客服等运营能力和部分行业能力。说明对于生活服务、电商等行业特殊认证的能力，待小程序完成绑定代运营服务商、自营等行业角色后，才可获得。
进阶能力	小程序通过平台试运营期后默认获得的能力。关于小程序试运营期介绍详情请查看小程序试运营说明。
高级能力	在小程序满足特定条件时通过申请可获得的能力，当小程序满足信用分、服务类目等条件时，开发者可在控制台内申请对应能力，完成审批通过后即可获取能力。说明小程序处于试运营期且满足条件时，也可申请对应能力。

基础能力

创建小程序后，通常默认获得的能力，一般用于实现小程序的基本功能以及一些运营、行业能力，例如页面导航的设置、图片视频操作、数据缓存设置等，另外也包括小程序挂载、IM 客服等运营能力和部分行业能力。

注：对于生活服务、电商等行业特殊认证的能力，待小程序完成绑定代运营服务商、自营等行业角色后，才可获得。

能力名称	能力描述	相关文档
可用性判断	•判断小程序的 API、组件等是否在当前版本可用。 •判断某组件是否允许在上方放置其他组件。	•tt.canIUse •tt.canIPutStuffOverComponent
字符转化	将 Base64 字符串与 ArrayBuffer 对象互相转换	•tt.base64ToArrayBuffer •tt.arrayBufferToBase64
生命周期	在小程序生命周期中获取数据或执行动作，生命周期指：启动、退出等行为	•tt.getEnterOptionsSync •tt.getLaunchOptionsSync •tt.exitMiniProgram
窗口尺寸变化	监听窗口尺寸变化事件	•tt.onWindowResize •tt.offWindowResize
版本更新	获取更新管理器，并通过小程序执行更新事件	•tt.getUpdateManager
应用级事件	监听小程序全局事件，包含启动、退出后台等事件	•tt.onAppShow •tt.offAppShow •tt.onAppHide •tt.offAppHide •tt.offUnhandledRejection •tt.onUnhandledRejection •tt.onError •tt.offError •tt.onLazyLoadError •tt.offLazyLoadError •tt.onAppLaunch •tt.offAppLaunch
环境变量	获取小程序环境信息	•tt.getEnvInfoSync
性能	设置并获取缓冲区的性能数据	•tt.performance.getEntries •tt.performance.getEntriesByName •tt.performance.getEntriesByType •tt.performance.getCurrentPageEntries •tt.performance.getEntriesByPage •tt.performance.mark •tt.performance.clearMarks
线程	创建一个worker线程，目前限制最多只能创建一个 Worker	•tt.createWorker
数据缓存	设置、获取、删除本地缓存数据	•tt.getStorage •tt.getStorageSync •tt.setStorage •tt.setStorageSync •tt.removeStorage •tt.removeStorageSync •tt.clearStorage •tt.clearStorageSync •tt.getStorageInfo •tt.getStorageInfoSync
TTML	创建SelectorQuery 、IntersectionObserver实例	•tt.createSelectorQuery •tt.createIntersectionObserver •tt.NodesRef.boundingClientRect •tt.NodesRef.scrollOffset •tt.NodesRef.fields •tt.NodesRef.node
页面导航	保留或关闭页面，跳转指定页面	•tt.navigateTo •tt.redirectTo •tt.switchTab •tt.navigateBack •tt.reLaunch •navigator
网络连接	连接小程序网络，发起网络请求，上传/下载文件	•tt.request •tt.uploadFile •tt.downloadFile •tt.connectSocket
图片操作	用户对图片进行上传、保存等操作	•tt.chooseImage •tt.saveImageToPhotosAlbum
图片渲染	小程序内渲染展示图片	•tt.previewImage •tt.getImageInfo •tt.compressImage •image
录音	获取麦克风权限后，小程序实现录音功能	•tt.getRecorderManager
音频播放	小程序内完成音频播放功能	•tt.getBackgroundAudioManager •tt.createInnerAudioContext
视频操作	用户对视频进行上传、保存等操作	•tt.chooseVideo •tt.chooseMedia •tt.saveVideoToPhotosAlbum
视频播放	小程序内完成视频播放功能	•tt.preloadVideo •tt.createVideoContext •video
相机	获取摄像头权限后，小程序调用相机&展示画面等	•tt.createCameraContext •tt.createEffectCameraStream •camera
Canvas录制	获取录制器，录制小程序内Canvas画面	•tt.createMediaRecorder
地图	创建地图工具	•tt.createMapContext •map
文件管理器	对文件进行保存、读取、打开、复制、修改、删除等操作	•tt.saveFile •tt.getFileInfo •tt.getSavedFileList •tt.removeSavedFile •tt.getFileSystemManager
打开文档	打开预览文件管理器的文档	•tt.openDocument
小程序登录	执行、检测小程序态，并获取openid	•tt.login •tt.checkSession •code2Session
头像昵称	每次获取最新的抖音用户昵称，都需要用户授权	•tt.getUserProfile
头像昵称组件	无需用户授权，展示用户在抖音注册的头像/昵称	•open-data
支付	调起小程序收银台进行支付	•tt.pay
收货地址	调起用户编辑收货地址界面	•tt.chooseAddress
授权设置	获取用户在该小程序内的授权状态，或打开授权页面	•tt.getSetting •tt.openSetting •tt.showDouyinOpenAuth
埋点上报	自定义分析数据上报接口	•tt.reportAnalytics
关注头条号	关注、检查小程序绑定的头条号	•tt.followOfficialAccount •tt.checkFollowState
一次性订阅消息	经过用户授权后，可在抖音消息通知内发送一条消息	•订阅消息
模糊地理位置	获取用户的模糊地理位置	•tt.getLocation
打开地图	打开地图某个具体的位置	•tt.openLocation •tt.chooseLocation
网络状态	获取设备网络类型、网络状态、WIFI列表等	•tt.getNetworkType •tt.getWifiList •tt.onGetWifiList •tt.offGetWifiList •tt.getConnectedWifi •tt.onNetworkStatusChange •tt.offNetworkStatusChange
系统信息	获取设备系统信息，例如手机型号，系统版本等	•tt.getSystemInfo •tt.getDeviceInfoSync •tt.getSystemInfoSync
加速度计	监听加速度计数据	•tt.startAccelerometer •tt.stopAccelerometer •tt.onAccelerometerChange •tt.offAccelerometerChange
罗盘	监听罗盘数据	•tt.startCompass •tt.stopCompass •tt.onCompassChange •tt.offCompassChange
小程序扫码	启动小程序扫码功能	•tt.scanCode
屏幕状态	监听、设置屏幕功能，包含亮度、截图、录屏等事件	•tt.setKeepScreenOn •tt.onUserCaptureScreen •tt.offUserCaptureScreen •tt.getScreenBrightness •tt.setScreenBrightness •tt.disableUserScreenRecord •tt.onUserScreenRecord •tt.enableUserScreenRecord •tt.offUserScreenRecord
陀螺仪	监听陀螺仪数据	•tt.startGyroscope •tt.stopGyroscope •tt.onGyroscopeChange •tt.offGyroscopeChange
数据加密	获取加密随机数	•tt.getRandomValues
内存	监听手机内存资源	•tt.onMemoryWarning
画布	创建小程序画布	•tt.createCanvasContext •tt.createOffscreenCanvas •canvas
交互反馈	显示或隐藏消息提示框、loading等	•tt.enableAlertBeforeUnload •tt.showToast •tt.hideToast •tt.showLoading •tt.hideLoading •tt.showModal •tt.showActionSheet •tt.showFavoriteGuide •tt.disableAlertBeforeUnload
导航栏	设置或隐藏导航栏、导航条加载动画、首页按钮	•tt.showNavigationBarLoading •tt.hideNavigationBarLoading •tt.hideHomeButton •tt.setNavigationBarTitle •tt.setNavigationBarColor
菜单	获取菜单元素位置信息	•tt.getCustomButtonBoundingClientRect •tt.getMenuButtonBoundingClientRect
动画	创建动画实例	•tt.createAnimation
页面位置	滚动到页面目标位置	•tt.pageScrollTo
滑动返回	设置滑动返回的方式	•tt.setSwipeBackMode
下拉刷新	页面内下拉刷新	•tt.startPullDownRefresh •tt.stopPullDownRefresh
键盘	在特定场景下主动收起键盘	•tt.hideKeyboard
TabBar	设置 tabBar，并绘制展示元素	•tt.showTabBarRedDot •tt.showTabBar •tt.setTabBarStyle •tt.setTabBarItem •tt.setTabBarBadge •tt.removeTabBarBadge •tt.hideTabBarRedDot •tt.hideTabBar
分享	以图片、卡片、链接等方式分享小程序，分享配置参考《分享消息配置文档》	•share
抖音拍摄器	唤起抖音拍摄器	•uploadDouyin
分享/拍抖音面板	同时显示/隐藏右上角更多【分享】+【拍抖音】	•tt.showShareMenu •tt.hideShareMenu
拍抖音黑白名单	是否允许用户拍抖音功能挂载视频	•share_config
视频数据转化	小程序视频id与抖音视频id互转	•videoIdToItemId •itemIdToEncryptId
抖音视频页	跳转通过小程序抖音拍摄器发布的视频播放页	•button(open-type=navigateToVideoView)
数据模板	获取服务商平台自定义的数据字段	•tt.getExtConfig •tt.getExtConfigSync
文本组件	小程序渲染文本组件	•text •rich-text
进度条组件	小程序渲染进度条组件	•progress
图标组件	小程序渲染图标组件	•icon
视图容器	提供视图容器，并实现滑动、移动等效果	•view •scroll-view •swiper •swiper-item •movable-view •movable-area •mask
设置剪切板	设置剪切板内容	•tt.setClipboardData
表单组件	提供按钮、选择器、输入框组件	•button •checkbox •checkbox-group •form •Input •label •picker •picker-view •picker-view-column •radio •radio-group •slider •switch •textarea
广告能力	平台官方广告组件，包含激励视频广告、插屏广告	•tt.createRewardedVideoAd •tt.createInterstitialAd •ad广告
接口凭证	获取小程序的唯一调用凭据	•getAccessToken •client_token
数据安全	检测文本、图片是否包含敏感内容	•textAntidirt •imageCensor
小程序别名/标签搜索	开发者可针对小程序提供的服务类型申请搜索标签词，审核通过后，开放平台会在抖音用户搜索服务标签时按策略为用户曝光同标签小程序	•小程序别名/标签搜索
抖音IM客服	抖音IM客服能力，详情查看IM客服介绍	•button(open-type=im)
跳转抖音号个人页	跳转抖音号个人页面	•button(open-type=openAwemeUserProfile)
关注抖音号	“关注抖音号弹窗”接口和组件，支持品牌号、员工号	•tt.followAwemeUser •aweme-user-card
跳转直播间	从小程序跳转到直播间	•button(open-type=openWebcastRoom)
直播呼吸灯	小程序展示直播间开播状态，并可跳转至直播间	•aweme-data
直播预览流	小程序实时播放抖音直播间内容，并可跳转至直播间	•live-preview
电话	用户点击可拉起手机拨号	•tt.makePhoneCall
短信	调起系统短信发送页面	•tt.sendSms
网页容器	提供用于承载其他网页的webview容器	•web-view
刷新票据	用于刷新refresh_token有效期，延长用户授权最长有效期，最长5次；用户最长授权195天	•刷新授权调用凭证
增量授权	传入多个能力，仅展示用户未授权的能力，已授权的能力，免二次授权，且刷新有效期；仅通过tt.showdouyinAuth调用即可	•incremental_authorization
本地生活团购抽佣	本地生活团购抽佣设置	•生活服务代运营服务商 CPS 接入指南
短视频自主挂载	拥有短视频自主挂载能力后，授权成功的账号可通过抖音发布页、小程序内“拍抖音”功能挂载自有小程序进行视频发布，发布后的视频会带上相应的小程序锚点	•短视频自主挂载能力
短视频达人推广挂载	拥有达人推广视频挂载能力，且创作者入驻小程序推广计划后，可以在抖音视频发布页或者小程序推广计划内接单，发布投稿视频并挂载小程序，发布后的视频会带上相应的小程序锚点	•短视频达人推广挂载能力
直播自主挂载	拥有直播自主挂载能力后，授权成功的账号可通过抖音开播页完成自有小程序的直播挂载	•直播自主挂载能力
直播达人推广挂载	拥有达人推广直播挂载能力，且创作者入驻小程序推广计划后，可通过抖音开播选择小程序任务，用户开播后观众可在直播内看到小雪花（小程序）入口	•直播达人推广能力
基础搜索	用户可通过小程序名称在搜索结果里展示相应的小程序，点击该条搜索结果，直接打开小程序	•搜索入口
个人页挂载小程序	开发者可以在抖音开放平台后台上申请添加抖音个人页挂载信息，添加成功后，抖音号主页上会显示相应小程序的入口，点击会跳转到小程序的落地页。	•抖音个人页挂载
电商插件小程序会员运营	围绕抖音电商店铺会员运营场景，提供会员基础信息查询、会员入会、会员积分等级查询及积分发放扣减等能力，辅助商家通过小程序完成抖店会员的获客及转化	•电商插件小程序会员运营
电商插件小程序权益核销	通过提供抖音店铺优惠券发放接口，辅助商家通过小程序实现对粉丝、任务用户、目标客群和活动节点的优惠券发放，更有效的承接交易效率的提升及转化	•电商插件小程序权益核销
电商插件小程序流量引导	通过提供跳转进店铺进商品详情及订单列表及电商客服等能力，辅助商家借助小程序能力将从公域获取的消费流量向自己的私域阵地引流从而为电商商家私域蓄水	•电商插件小程序流量引导
电商插件小程序导购成交	通过提供基于小程序内可实现的抖店商品加购及下单后订单查询服务，辅助商家利用小程序实现活动营销热品导购等运营承载	•电商插件小程序导购成交
电商插件小程序商品、订单查询	开发者可通过前往抖店开放平台申请对服务端开放接口实现对商品和订单的信息查询	•电商插件小程序商品订单查询
电商插件小程序C2B定制	提供一系列接口能力辅助商家通过小程序实现商品的定制信息采集，定制状态查询，定制预览图回传等能力	•电商插件小程序C2B定制
抖店和小程序用户标识	提供小程序openid与抖店openid转化，辅助商家跨平台应用之间用户唯一性校验等场景	•电商插件小程序其他特供能力
线索组件配置	通过小程序线索组件配置，开发者可标识 Form 组件是否用于留资目的。通过标识，平台可感知 Form 表单用途以及对应的用户行为数据，用于算法消费，因此可有效提升小程序的展现和留资量。	•线索组件配置
生活服务行业门店匹配与信息同步	商家门店与抖音门店信息匹配，以及查询门店状态、更新门店信息的能力，融合后在抖音来客维护，此能力供旅行社使用	•商铺同步
生活服务行业商品同步	现有生活服务商品需同步至抖音平台，此部分能力为商家创建、查询、修改商品信息使用的接口信息，商品接口分为新旧两套此部分为旧接口，仅存量部分商家使用	•查询商品模板 •创建/修改团购商品 •查询商品品类 •免审修改商品 •上下架商品 •同步库存
生活服务行业商品同步（新）	现有生活服务商品需同步至抖音平台，此部分能力为商家创建、查询、修改商品信息使用的接口信息，商品接口分为新旧两套此部分为新接口，新增商家全部使用新商品接口	•查询商品模板 •查询商品品类 •创建/修改团购活动 •免审修改商品 •上下架商品 •同步库存
生活服务交易系统（新）	生活服务商家交易能力接入，包含下单、支付、核销、退款接口，接入能力后商家可完成订单交易	•生活服务交易系统流程简介
平台官方客服	平台官方客服能力，平台官方客服能力，商家接入完成后可支持用户联系平台客服解决问题	•button(open-type=platformIm)
评价能力	平台评价能力，支持通过OpenAPI、jsapi、组件的方式接入，商家选择其中一种完成接入即可	•获取评价数据 •tt.rateAwemeOrder
生活服务行业营销能力	平台营销能力，支持商家查询、发布、修改佣金方案，以及查询达人列表、达人带货数据、以及具体带货详情	•发布/修改通用佣金计划 •修改通用佣金计划状态 •查询通用佣金计划 •通用佣金计划查询带货数据 •通用佣金计划查询带货达人列表 •通用佣金计划查询达人带货数据 •通用佣金计划查询达人带货详情
生活服务核销工具能力	用于核销原生券的小程序使用的能力，包含查询用户券列表、查询原生订单可用门店、原生券核销消息通知	•查询用户券列表 •查询订单可用门店 •券核销消息通知 •撤销核销消息通知
小程序券	抖音开放平台为小程序开发者打造的，帮助小程序经营者在抖音体系内通过「券」载体在直播间、私域、侧边栏、推荐feed流、抖音官方卡券包、机制消息等场景高效实现获客、转化和业务增长的营销能力。	•小程序券
抖音主页数据（品牌号、员工号、合作号）	通过品牌号、员工号、合作号等经营授权，查询抖音用户的主页数据，包含点赞、粉丝、评论、分享、主页访问等	•获取用户视频情况 •获取用户粉丝数 •获取用户点赞数 •获取用户评论数 •获取用户分享数 •获取用户主页访问数
视频数据查询（品牌号、员工号、合作号）	通过品牌号、员工号、合作号等经营授权，查询最新指定抖音视频数据，包含标题、发布时间、播放、点赞、评论等	•查询特定视频的视频数据
近30天视频数据查询（品牌号、员工号、合作号）	通过品牌号、员工号、合作号等经营授权，查询近30天指定抖音视频的数据，包含标题、发布时间、播放、点赞、评论等	•获取视频基础数据 •获取视频点赞数据 •获取视频评论数据 •获取视频播放数据 •获取视频分享数据
视频评论数据（品牌号、员工号、合作号）	通过品牌号、员工号、合作号等经营授权，获取抖音用户公开视频下的评论内容、评论点赞、评论回复等内容	•评论列表 •评论回复列表 •回复视频评论

进阶能力

小程序通过平台试运营期后默认获得的能力。注：关于小程序试运营期的详细介绍，请查看小程序试运营说明。

能力名称	能力描述	接口名称
获取手机号	经过用户授权后，获取用户抖音注册的手机号	•getPhoneNumber
跳转小程序	跳转到其他小程序	•tt.navigateToMiniProgram •tt.navigateBackMiniProgram
振动	触发手机短时/长时振动	•tt.vibrateShort •tt.vibrateLong
读取剪贴板	读取剪贴板内容，并粘贴至小程序	•tt.getClipboardData
Link链接	批量获取打开小程序的link分享链接	•生成Link •查询Link •查询Link配额
Schema链接	批量获取打开小程序的Schema分享链接	•生成Schema •查询Schema •查询Schema配额
二维码	批量获取小程序二维码	•生成QRCode
私信	提供加入抖音私信组件	•button(open-type=privateMessage)
主动授权私信	经用户授权后，开发者可通过IM消息收发接口回复用户	•button(open-type=authorizePrivateMessage)
粉丝群	提供加入粉丝群组件	•button(open-type=joinGroup)
创建粉丝群	允许小程序开发者代替群主创建、查询粉丝群	•查询群信息 •创建聊天群 •查询用户剩余建群额度 •图片上传工具API

高级能力

当小程序满足信用分、服务类目等特定条件时，开发者可在控制台申请对应能力，审批通过后即可使用。注：小程序处于试运营期且满足条件时，也可申请对应能力。

能力名称	能力描述	相关文档
检查用户粉丝关系	检查用户是否关注“小程序绑定的抖音号”，包括品牌号、员工号	•tt.checkFollowAwemeState
长期订阅消息	经过用户授权后，可在抖音消息通知内发送多条消息；接口是基础能力，但长期订阅消息模板需申请	•订阅消息
高精度地理位置	实时获取用户的精确地理位置；接口是基础能力，但返回高精度信息需申请	•tt.getLocation •tt.startLocationUpdate
AI算法管理器	创建算法管理器、原生神经网络等	•tt.getAlgorithmManager •tt.createBytennEngineContext •tt.createStickerManager
自定义导航栏	实现页面结构自定义能力后，顶部标准化导航栏将不显示，开发者可自定义顶部导航栏样式	•自定义页面结构
日历	添加、查询、删除用户设备系统日历	•button(open-type=addCalendarEvent) •tt.deleteCalendarEvent
快捷桌面	可以将小程序快捷方式添加到手机桌面上	•button(open-type=addShortcut)
直播组件	直播组件，用于实时音视频流播放	•live-player
RTC组件	创建RTC房间组件，用户能够双向连麦通话	•rtc-room
视频评论数据	经用户授权后获取其抖音公开视频下的所有评论及评论回复，包含评论内容、评论点赞、评论回复等内容	•评论列表 •评论回复列表 •回复视频评论
抖音主页数据	查询近30天该抖音账号的主页数据含点赞、粉丝、评论、分享、主页访问	•获取用户视频情况 •获取用户粉丝数 •获取用户点赞数 •获取用户评论数 •获取用户分享数 •获取用户主页访问数
查询视频数据	查询最近 1 日内视频 ID 的基础信息（标题、发布时间等）和实时数据（播放量、点赞量、评论量等）	•查询特定视频的视频数据
查询近30天视频数据	查询近30天视频ID的基础信息（标题、发布时间等）和实时数据（播放量、点赞量、评论量等）	•获取视频基础数据 •获取视频点赞数据 •获取视频评论数据 •获取视频播放数据 •获取视频分享数据
短视频ugc（用户创作）挂载能力	开通该能力后，拥有小程序视频挂载权限的用户可通过抖音发布页、小程序内“拍抖音”功能挂载小程序发布视频，发布的视频将展示小程序锚点	•短视频 UGC（用户创作）挂载能力
视频锚点图标更换	对满足申请条件的开发者，支持其在后台选择是否将小程序 icon 用作短视频锚点 icon，同时对小程序名称字数过长的短视频挂载小程序提供锚点标题配置功能。	•视频图标和标题配置
直播ugc（用户创作）挂载能力	开通该能力后，拥有小程序直播挂载权限的用户可通过抖音开播挂载小程序，用户开播后观众可在直播间看到小雪花（小程序）入口	•直播 UGC（用户创作）挂载能力
直播自定义讲解卡	开发者通过接口配置自定义讲解卡信息	•图片上传 •图片审核状态查询 •图片删除 •设置全局默认配置 •设置指定页面配置 •查询全局默认配置 •查询指定页面配置 •删除指定页面配置 •讲解卡动态更新
搜索服务直达	搜索是承接用户主动探索小程序的重要场景，为更好的满足用户在搜索场景下对按服务名称搜索的业务需求，抖音开放平台为小程序开发者提供编辑小程序子服务搜索的申请入口，从而更好的提升小程序在搜索场景下的品牌曝光度。	•搜索服务直达
三方码	订单券码类型分为三方码与抖音码，抖音码由平台更新状态，三方码由商家更新券码状态，此能力用于需要使用三方码的商家申请使用	•预下单回调
部分退款能力	退款接口中，支持部分退款，用于用户违约造成商家资损的场景，此场景下支持商家回传退款的金额	•发起退款
短视频挂载权限判断	判断小程序是否拥有短视频挂载权限	•挂载权限校验