抖音开放平台Logo
开发者文档
控制台

tt.showDouyinOpenAuth
收藏
我的收藏

基础库 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

错误码

errNoerrMsg说明最低支持版本
10301feature is not supported in app

宿主不支持登录/宿主不支持抖音开放平台授权

1.93.0
21000login fail xxx

用户登录失败

1.93.0
21101request auth ticket fail xxx

获取权限票据失败

1.93.0
21102request auth scope info fail xxx

获取权限信息失败

1.93.0
21103request auth code fail xxx

获取权限授权码失败

1.93.0
20000scopes is empty

开发者传入的 scopes 为空数据

1.93.0
21104no usage scope

没有可用的授权权限(开发者申请授权的权限全部没有被开通权限)

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); }, });