抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • JS API 列表
  • 基础
  • TTML
  • 网络
  • 媒体
  • 地图
  • 文件
  • 数据缓存
  • 地理位置
  • 设备
  • 画布
  • 界面
  • 页面导航
  • 开放接口
  • 登录
  • 用户信息
  • 广告
  • 营销能力
  • 支付
  • 分享
  • 小程序跳转
  • 抖音视频能力
  • 收货地址
  • 设置
  • 授权
  • 评价能力
  • 数据分析
  • 视频拍摄器
  • 引导关注
  • 订阅消息
  • 电商插件能力(即将废弃)
  • 流量来源识别
  • 隐私信息授权
  • web化
  • 转发和挂载
  • 侧边栏能力
  • tt.getSidebarActivity
  • tt.navigateToScene
  • tt.updateSidebarActivity
  • tt.createSceneActivityContext
  • SceneActivityContext
  • 直播能力
  • AI/AR能力
  • 安全能力
  • 行业开放
  • 第三方平台
  • 其它
  • 生活服务(即将废弃)
  • tt.navigateToScene

    收藏
    我的收藏

    基础库 3.6.0 开始支持本方法,低版本需做[兼容处理],这是一个异步方法。

    调用该 API 可以跳转到某个小程序入口场景,目前仅支持跳转「侧边栏」场景。参考下图:​

    前提条件
    业务背景
    使用限制
    注意事项
    支持宿主:抖音
    支持沙盒
    相关教程

    语法

    tt.navigateToScene(options)

    参数说明

    options 为 object 类型,属性如下:

    属性名类型默认值必填说明最低支持版本
    sceneenum

    需要确认的入口场景(目前仅支持的入参为'sidebar')​

    3.6.0
    activitystring

    活动 id, 用于控制弹窗活动类型。​

    ​创建活动id:使用 OpenAPI 创建营销活动 或在小程序控制台-运营-营销-营销活动-复访营销中创建。​

    ​查询活动id:使用 JsAPI tt.getSidebarActivity、或在小程序控制台-运营-营销-营销活动-复访营销中查询。

    3.6.0
    successfunction
    接口调用成功的回调函数
    3.6.0
    failfunction
    接口调用失败的回调函数
    3.6.0
    completefunction
    接口调用结束的回调函数(调用成功、失败都会执行)
    3.6.0

    回调成功

    object 类型,属性如下:

    属性名类型说明最低支持版本
    codeenum
    code
    3.6.0
    errMsgstring
    "navigateToScene:ok"
    3.6.0

    code 的合法值

    说明最低支持版本
    0
    0 - 成功跳转​
    3.6.0
    1
    1 - 用户取消​
    3.6.0

    回调失败

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring
    "navigateToScene:fail" + 详细错误信息
    3.6.0

    错误码

    errorCodeerrMsgerrorType说明最低支持版本
    173086invoke too frequentlyD
    调用频繁
    3.6.0
    173091internal errorF
    小程序框架内部错误,有需要请创建工单咨询
    3.6.0
    173099expect params.scene to be one of "sidebar" or params.activity should be stringD
    参数错误

    请根据错误信息修改参数类型

    3.6.0

    扫码体验

    请使用字节宿主APP扫码

    代码示例

    开发者工具中预览

    tt.navigateToScene({ scene: 'sidebar', activity: '', // 需改成自己小程序生效中的activity id。activity 为可选项,不填或者填写错误 id,会表现为兜底样式 success: (data) => { console.log(data) }, fail: (data) => { console.log(data) } })