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

    提供小游戏获取抖音权限的能力,展示出抖音权限授权弹窗。

    前提条件

    在使用在接口前,需要小游戏拥有者登录抖音开放平台申请开通小游戏需要的权限(如下图所示)。

    具体路径:控制台 -> 运营 -> 抖音开放能力

    业务背景
    使用限制

    该接口只支持抖音,所以请在抖音 APP 中调用;

    注意事项
    • 每次申请授权都是该小游戏的抖音权限全量授权,请在传入 scopes 时,把需要的授权的 scopes 都传入。由于不支持增量授权,即使用户已经授权过部分抖音权限,也还是需要全量传入所有需要的权限;
    • 每次申请授权的抖音权限必须是在抖音开放平台已经申请并且审批开通的权限,否则会导致本次授权操作失败;
    • 此处授权是抖音相关的授权,如果想要申请小游戏授权,请查看 tt.authorize。这两处授权的 scopes 范围不同;
    • 在请求服务端接口时,应用唯一标识 在小游戏场景下,对应的是小游戏 appId;应用唯一标识对应的密钥对应的是小游戏的 APP Secret。
    相关教程

    语法

    tt.showDouyinOpenAuth(options)

    参数说明

    options 为 object 类型,属性如下:

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

    需要获取权限的信息,其中 key 值是申请权限的 scope,value 值必须是 0,1,2(此处申请的权限在抖音开放平台必须是已开通状态)

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

    scopes 参数说明

    scopes 的属性值必需是0, 1, 2

    属性值

    类型

    说明

    版本

    0

    number

    必选项(用户无法取消)

    1.93.0

    1

    number

    非必选,默认选中

    1.93.0

    2

    number

    非必选,默认不选中

    1.93.0

    回调成功

    object 类型,属性如下:

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

    请求授权返回的票据,此处对标开放平台的 authCode

    1.93.0
    grantPermissionsarray

    用户授权的权限

    1.93.0
    errMsgstring
    "showDouyinOpenAuth:ok"
    1.93.0

    ticket 参数说明

    此处返回的临时票据 ticket,是用来从开放平台的接口(点击进入接口详情)获取用户的长期票据access_token。开发平台的授权流程示意图如下:

    回调失败

    object 类型,属性如下:

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

    错误码

    errorCodeerrMsgerrorType说明最低支持版本
    122101android:login fail %sF
    小游戏框架内部错误,有需要请创建工单咨询
    1.93.0
    999999scopes is emptyD
    1.93.0
    999990auth denyU
    1.93.0
    122101android:login fail iOS:login fail loginHostFail %sF
    小游戏框架内部错误,有需要请创建工单咨询
    1.93.0
    122102request auth ticket fail %sF
    小游戏框架内部错误,有需要请创建工单咨询
    1.93.0
    122103request auth scope info fail %sF
    小游戏框架内部错误,有需要请创建工单咨询
    1.93.0
    122104request auth code fail %sF
    小游戏框架内部错误,有需要请创建工单咨询
    1.93.0
    122105no usage scopeD
    1.93.0
    999993unknown errorF
    小游戏框架内部错误,有需要请创建工单咨询
    1.93.0
    999999invalid paramD
    参数错误
    1.93.0
    999993internal errorF
    小游戏框架内部错误,有需要请创建工单咨询
    1.93.0
    999987feature is not supported in appD
    1.93.0
    122106auth denyU
    1.93.0

    代码示例

    tt.showDouyinOpenAuth({ scopes: { im: 0, // 用户无法取消 "im.media": 2, }, success(res) { console.log("success", res); }, fail(res) { console.log("fail", res); }, complete(res) { console.log("complete", res); }, });