抖音开放平台Logo
开发者文档
小程序
控制台
  • JS API 列表
  • 基础
  • TTML
  • 网络
  • 媒体
  • 地图
  • 文件
  • 数据缓存
  • 地理位置
  • 设备
  • 画布
  • 界面
  • 页面导航
  • 开放接口
  • 行业开放
  • 第三方平台
  • 其它

    • tt.login
    收藏
    我的收藏

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

    调用该 API 可以获取用户临时的登录凭证。Codelab 教程，请参考 30分钟搞定小程序登录。

    前提条件无
    业务背景无
    使用限制无
    注意事项
    • Tip：force 为 true 时(默认值为 true), 如果用户未在宿主登录(例如未在头条 App 登录), 则会调起宿主的登录窗口, 如果用户点击取消则会回调 host login fail；
    • Tip：只有宿主登录的用户 success 才有 code, 否则只有 anonymousCode；
    • Tip：code 可以换取 openid、unionid, openid 是用户在当前小程序的 ID，unionid 是用户在小程序平台的唯一标识符，如果开发者拥有多个小程序，可通过 unionid 来区分用户的唯一性；
    • Tip：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 类型，属性如下：

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

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

    		1.0.0
    isLoginboolean
    判断在当前 APP（头条、抖音等）是否处于登录状态。
    		1.0.0
    anonymousCodestring
    用于标识当前设备, 无论登录与否都会返回, 有效期 5 分钟。
    		1.0.0
    errMsgstring
    "login:ok"
    		1.0.0

    回调失败

    object 类型，属性如下：

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

    错误码

    errorCodeerrMsgerrorType说明最低支持版本
    113001login:fail host login failU
    用户取消宿主登录

    用户取消宿主登录，无需关注

    		1.0.0
    113094login:fail app in backgroundU
    用户错误，用户将小程序退至后台导致此错误

    小程序在后台时，该api无法调用。建议您在调用此 api 前使用 tt.onAppHide 方法判断小程序是否已经进入后台，并只有在小程序在前台时才进行调用

    		1.0.0
    113085login:fail network unavailableU
    用户错误

    用户网络不佳，若此错误频繁出现建议加入超时重试逻辑

    		1.0.0
    113091login:fail Internal error %sF
    小程序框架内部错误，有需要请创建工单咨询
    		1.0.0
    113002login:fail service error %s（Android特有）F
    小程序框架内部错误，有需要请创建工单咨询
    		1.0.0
    113002login:fail service error %s (IOS 特有)U
    用户网络问题
    		1.0.0

    扫码体验

    请使用字节宿主APP扫码

    代码示例

    开发者工具中预览

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