基础库 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 类型，属性如下：

属性名	类型	默认值	必填	说明	最低支持版本
force	boolean	true	否	未登录时, 是否强制调起登录框	1.0.0
success	function		否	接口调用成功的回调函数	1.0.0
fail	function		否	接口调用失败的回调函数	1.0.0
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）	1.0.0

回调成功

object 类型，属性如下：

属性名	类型	说明	最低支持版本
code	string	临时登录凭证, 有效期 5 分钟。开发者可以通过在服务端调用登录凭证校验接口换取 openid 和 session_key 等信息。	1.0.0
isLogin	boolean	判断在当前 APP（头条、抖音等）是否处于登录状态。	1.0.0
anonymousCode	string	用于标识当前设备, 无论登录与否都会返回, 有效期 5 分钟。	1.0.0
errMsg	string	"login:ok"	1.0.0

回调失败

object 类型，属性如下：

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

错误码

errorCode	errMsg	errorType	说明	最低支持版本
113001	login:fail host login fail	U	用户取消宿主登录用户取消宿主登录，无需关注	1.0.0
113094	login:fail app in background	U	用户错误，用户将小程序退至后台导致此错误小程序在后台时，该api无法调用。建议您在调用此 api 前使用 tt.onAppHide 方法判断小程序是否已经进入后台，并只有在小程序在前台时才进行调用	1.0.0
113085	login:fail network unavailable	U	用户错误用户网络不佳，若此错误频繁出现建议加入超时重试逻辑	1.0.0
113091	login:fail Internal error %s	F	小程序框架内部错误，有需要请创建工单咨询	1.0.0
113002	login:fail service error %s（Android特有）	F	小程序框架内部错误，有需要请创建工单咨询	1.0.0
113002	login: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 调用失败`);
  },
});

开发者文档

tt.login
收藏
我的收藏

详细错误信息说明

语法

参数说明

回调成功

回调失败

错误码

扫码体验

代码示例

tt.login收藏我的收藏

详细错误信息说明

语法

参数说明

回调成功

回调失败

错误码

扫码体验

代码示例

tt.login
收藏
我的收藏