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

tt.onReceiveLiveInteractPluginMessage

收藏
我的收藏

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

用于接收直播间开放消息数据。

前提条件

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

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

语法

tt.onReceiveLiveInteractPluginMessage(callback)

参数说明

callback

类型默认值必填说明最低支持版本
function
收到消息后触发的回调函数
3.41.0

callback 是一个回调函数,接收类型参数如下:

属性名类型说明最低支持版本
msg_idstring
消息 id,通用返回
3.41.0
timestampnumber
时间戳,通用返回
3.41.0
sec_open_idstring
用户的加密 openid,通用返回
3.41.0
avatar_urlstring
用户头像,通用返回
3.41.0
nicknamestring
用户昵称,通用返回
3.41.0
like_numnumber

点赞数量

监听 live_like 消息返回(需要开启「获取点赞互动数据」权限)

3.41.0
contentstring

评论内容

监听 live_comment 消息返回(需要开启「直播间评论互动数据」权限)

3.41.0
gift_numnumber

送出的礼物数量

监听 live_gift 消息返回(需要开启「获取礼物互动数据」权限)

3.41.0
use_follow_actionnumber

用户关注变更数据

监听 live_follow 消息返回(需要开启「直播间观众关注状态」权限)

3.41.0
fansclub_reason_typenumber

粉丝团变更原因

监听 live_fansclub 消息返回(需要开启「获取粉丝团互动数据」权限)

3.41.0
fansclub_levelnumber

粉丝团等级

需要开启「直播间观众粉丝团详细信息」权限后额外返回

3.41.0
user_privilege_levelnumber

用户荣誉等级

需要开启「直播间观众荣誉等级」权限后额外返回

3.41.0
is_follow_anchorboolean

用户是否关注主播

需要开启「直播间关注互动数据」权限后额外返回

3.41.0

返回值

代码示例

tt.onReceiveLiveInteractPluginMessage((res) => { console.log('消息数据:', res); });