开发
API

tt.unsubscribeAudiencesFollowAction

基础库 2.28.0 开始支持本方法,该 API 为异步 API。
调用方:主播端
使用该功能前,开发者需要申请并通过「直播能力」准入,并开通「获取关注互动数据」能力,具体可参考接入流程

取消订阅当前直播间观众的关注/取消关注行为。

语法

tt.unsubscribeAudiencesFollowAction(options);

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
successfunction接口调用成功的回调函数2.28.0
failfunction接口调用失败的回调函数2.28.0
completefunction接口调用结束的回调函数(调用成功、失败都会执行)2.28.0

回调成功

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

属性名类型说明最低支持版本
errMsgstring"unsubscribeAudiencesFollowAction:ok"2.28.0

回调失败

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

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

errNo 的可枚举值:

描述
40001参数错误
40002没有调用权限
40007接口调用频率过高

代码示例

开发者工具中预览

tt.unsubscribeAudiencesFollowAction({
    success(res) {
        console.log("取消订阅成功");
    },
    fail(res) {
        console.log(`取消订阅失败,错误码:${res.errNo}`);
    },
});

Bug & Tip

  • Tips:目前该接口只支持抖音 App,版本需满足 18.2.0 版本及以上
点击纠错
评价此篇文档