抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • API 概览
  • C# API
  • 开放接口
  • 登录
  • 侧边栏能力
  • 设置
  • 授权
  • tt.authorize
  • tt.showDouyinOpenAuth
  • 添加到桌面
  • 游戏排行榜
  • 订阅消息
  • 开放数据域
  • 开放数据
  • 开放数据分组
  • 客服消息
  • 直播能力
  • 推荐流直出游戏能力
  • 公会群能力
  • 意见反馈
  • 游戏站
  • 收藏
  • 群聊
  • 关注
  • 数据分析
  • 基础
  • 渲染
  • 设备
  • 文件
  • 位置
  • 媒体
  • 网络
  • 转发
  • 数据缓存
  • 广告
  • 界面
  • 支付
  • Worker
  • tt.authorize
    收藏
    我的收藏

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

    提前向用户发出用户授权请求。该方法不会调用对应接口,只会弹框咨询用户是否授权或者获取用户信息。如果用户之前有授权,该接口直接返回成功,不会跟用户产生交互。

    前提条件
    业务背景
    使用限制
    注意事项

    获取用户信息授权(scope.userInfo)前需要先调用 tt.login,否则会出现"authroize:fail invalid session"报错

    相关教程

    语法

    tt.authorize(options)

    参数说明

    options 为 object 类型,属性如下:

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

    需要预授权的 scope,详见 用户授权 scope 说明

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

    回调成功

    object 类型,属性如下:

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

    授权结果

    1.3.0
    errMsgstring

    "authorize:ok"

    1.3.0

    data 参数说明

    data 是申请的授权结果,其中 key 为入参的 scope,value 为授权结果,如:

    data: { "scope.userInfo": "ok" }

    data 类型说明

    object 类型,属性如下:

    属性名类型说明最低支持版本
    scope.userInfostring

    是否授权用户信息

    1.3.0
    scope.userLocationstring

    是否授权地理位置

    1.3.0
    scope.recordstring

    是否授权麦克风功能

    1.3.0
    scope.albumstring

    是否授权保存到相册

    1.3.0
    scope.camerastring

    是否授权摄像头

    1.3.0
    scope.screenRecordstring

    是否授权录屏,默认为开。在 onError 里面报错到没有录屏权限时,可以尝试主动调用

    1.3.0
    scope.calendarstring

    是否授权向系统日历添加事件

    1.3.0
    scope.gameClubstring

    是否授权获取游戏站数据

    3.77.0
    scope.groupTagstring

    是否授权使用群聊标签

    3.78.0

    回调失败

    object 类型,属性如下:

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

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

    1.3.0

    错误码

    errNoerrMsg说明最低支持版本
    21105/s
    %s 代表占位符。
    1.3.0
    21102auth deny
    1.3.0
    10401internal auth error
    小游戏框架内部错误,有需要请创建工单咨询
    1.3.0
    21101invalid scope
    1.3.0
    21103batched auth permission deny
    1.3.0
    21104%s not support batched auth
    1.3.0
    20001invalid param
    参数错误
    1.3.0
    20000internal error
    小游戏框架内部错误,有需要请创建工单咨询
    1.3.0
    20000Scope is NULL.
    1.3.0
    10401Internal error: platform auth deny
    小游戏框架内部错误,有需要请创建工单咨询
    1.3.0
    21106not login
    1.3.0

    扫码体验

    请使用字节宿主APP扫码

    代码示例

    开发者工具中预览

    tt.authorize({ scope: "scope.userInfo", success() { // 用户同意授权用户信息 }, fail(failObj) { console.log('fail', failObj.errMsg, failObj.errNo); } });