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

tt.subscribeLiveInteractPluginMessage

收藏
我的收藏

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

用于订阅直播间开放消息数据。

前提条件

需要在抖音开放平台创建插件,并申请「互动数据」权限

业务背景
使用限制
注意事项
支持沙盒
相关教程

语法

tt.subscribeLiveInteractPluginMessage(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
messageTypeArray<string>
需要订阅的开放消息类型
3.41.0
successfunction
接口调用成功的回调函数
3.41.0
failfunction
接口调用失败的回调函数
3.41.0
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)
3.41.0

messageType 参数说明

MessageType 是个数组,数组中可以传以下枚举:

MessageType

说明

对应能力申请

live_like

获取点赞互动数据


live_comment

获取直播间评论互动数据

live_gift

获取礼物互动数据

live_follow

获取直播间观众关注状态

live_fansclub

获取粉丝团互动数据


回调成功

object 类型,属性如下:

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

回调失败

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"subscribeLiveInteractPluginMessage:fail " + 错误信息
3.41.0

错误码

errNoerrMsg说明最低支持版本
21305permission denied
无权限
3.41.0
21306fail to request subscribe message
start_im_task 接口请求失败
3.41.0
21307do not subscribe messages before creating a live card
卡片未创建
3.41.0

代码示例

tt.subscribeLiveInteractPluginMessage({ messageType: ['live_like', 'live_comment'], success(res) { console.log('调用成功:', res); }, fail(res) { console.log('调用失败:', res); } });