开发
API

tt.showDouyinOpenAuth

基础库 1.93.0 开始支持本接口。

提供小程序获取抖音权限的能力,展示出抖音权限授权弹窗。在使用在接口前,需要小程序拥有者登录抖音开发平台申请相应开通需要的权限。

语法

tt.showDouyinOpenAuth(options)

参数说明

options 为 Object 类型,属性如下:|

属性名类型默认值必填说明最低支持版本
scopesobject--需要获取权限的信息,
其中 key 值是申请权限的 scope.name,value 值必须是 0,1,2。
1.93.0
successfunction--接口调用成功的回调函数1.93.0
failfunction--接口调用失败的回调函数1.93.0
completefunction--接口调用结束的回调函数(调用成功、失败都会执行)1.93.0

scopes 的属性值说明:

属性值类型说明版本
0number必选项1.93.0
1number非必选,默认选中1.93.0
2number非必选,默认不选中1.93.0

回调成功

参数为 Object 类型,属性如下:

参数参数类型说明最低支持版本
errMsgstring回调信息1.93.0
ticketstring请求授权返回的票据1.93.0
grantPermissionsstring[]用户授权的权限1.93.0

注:此处 ticket 是返回的临时票据,用来从开放平台获取用户的授权令牌(access_token)的。

回调失败

参数为 Object 类型,属性如下:

参数参数类型说明最低支持版本
errNonumber错误码1.93.0
errMsgstring错误信息1.93.0

错误信息说明:

errNoerrMsg说明最低支持版本
10301feature is not supported in app宿主不支持登录/宿主不支持抖音开放平台授权1.93.0
21100login 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,
    user_info: 1,
  },
  success: (res) => {
    console.log("success", res);
  },
  fail: (res) => {
    console.log("fail", res);
  },
  complete: (res) => {
    console.log("complete", res);
  },
});

Bug & Tip

  • Tips:该接口只支持抖音,所以请在抖音 APP 中调用。
  • Tips:每次申请授权都是该小程序的抖音权限全量授权,请在传入 scopes 时,把需要的授权的 scopes 都传入。由于不支持增量授权,即使用户已经授权过部分抖音权限,也还是需要全量传入所有需要的权限。
  • Tips:每次申请授权的抖音权限必须是在抖音开发平台已经申请并且审批开通的权限,否则会导致本次授权操作失败。
点击纠错
评价此篇文档