抖音开放平台Logo
开发者文档
控制台
  • API 概览
  • 开放能力
  • 登录
  • tt.login
  • tt.checkSession
  • 社交转发裂变
  • 用户信息及授权
  • 小游戏收藏
  • 群聊
  • 关注
  • 游戏互推组件
  • 添加到桌面
  • 游戏排行榜
  • 数据分析
  • 视频拍摄器
  • 订阅消息
  • 关系链
  • 客服能力
  • 侧边栏能力
  • 推荐流直出游戏能力
  • 基础
  • 渲染
  • 设备
  • 文件
  • 位置
  • 媒体
  • 网络
  • 游戏转发分享
  • 实时语音
  • 数据缓存
  • 系统
  • 广告
  • 界面
  • 支付
  • Worker
  • tt.login
    收藏
    我的收藏

    基础库 1.0.0 开始支持本方法,这是一个异步方法。

    调用该 API 可以获取用户临时的登录凭证。

    前提条件
    业务背景
    使用限制
    注意事项
    • forcetrue 时(默认值为 true), 如果用户未在端登录(例如未在头条 App 登录), 则会调起端的登录窗口, 如果用户点击取消则会调用 fail
    • 只有端登录的用户 success 才有 code, 否则只有 anonymousCode
    • code 可以换取 openid, openid 是用户的唯一标识
    • anonymousCode 可以换取 anonymous_openid, 同一台手机 anonymous_openid 是相同
    相关教程

    语法

    tt.login(options)

    参数说明

    options 为 object 类型,属性如下:

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

    未登录时, 是否强制调起登录框

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

    回调成功

    object 类型,属性如下:

    属性名类型说明最低支持版本
    anonymousCodestring

    用于标识当前设备, 无论登录与否都会返回, 有效期 3 分钟。

    1.0.0
    isLoginboolean

    判断在当前 APP(头条、抖音等)是否处于登录状态。

    1.0.0
    codestring

    临时登录凭证, 有效期 3 分钟。开发者可以通过在服务器端调用登录凭证校验接口换取 openid 和 session_key 等信息。

    1.0.0
    errMsgstring

    "login:ok"

    1.0.0

    回调失败

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring

    "login:fail " + 详细错误信息

    1.0.0

    错误码

    errorCodeerrMsgerrorType说明最低支持版本
    999991getHostSessionFailF
    小游戏框架内部错误,有需要请创建工单咨询
    1.0.0
    999994app in backgroundU
    1.0.0
    999987feature is not supported in appD
    1.0.0
    999993internal errorF
    小游戏框架内部错误,有需要请创建工单咨询
    1.0.0
    999986login is in progress, please do not call againD
    1.0.0
    102701Internal error: login failedF
    小游戏框架内部错误,有需要请创建工单咨询
    1.0.0
    999991Internal error: service error xxxF
    小游戏框架内部错误,有需要请创建工单咨询
    1.0.0

    扫码体验

    请使用字节宿主APP扫码

    代码示例

    开发者工具中预览

    tt.login({ force: true, success(res) { console.log(`login 调用成功${res.code} ${res.anonymousCode}`); }, fail(res) { console.log(`login 调用失败`); }, });