tt.onReceiveLiveInteractPluginMessage
基础库 3.41.0 开始支持本方法,这是一个同步方法。
用于接收直播间开放消息数据。
| 前提条件 | 需要在 抖音开放平台创建插件,并申请「互动数据」权限 |
| 业务背景 | 无 |
| 使用限制 | 无 |
| 注意事项 | 无 |
| 支持沙盒 | 否 |
| 相关教程 | 无 |
语法
tt.onReceiveLiveInteractPluginMessage(callback)
参数说明
callback
| 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|
| function | 否 | 收到消息后触发的回调函数 | 3.41.0 |
callback 是一个回调函数,接收类型参数如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| msg_id | string | 消息 id,通用返回 | 3.41.0 |
| timestamp | number | 时间戳,通用返回 | 3.41.0 |
| sec_open_id | string | 用户的加密 openid,通用返回 | 3.41.0 |
| avatar_url | string | 用户头像,通用返回 | 3.41.0 |
| nickname | string | 用户昵称,通用返回 | 3.41.0 |
| like_num | number | 点赞数量 监听 live_like 消息返回(需要开启「获取点赞互动数据」权限) | 3.41.0 |
| content | string | 评论内容 监听 live_comment 消息返回(需要开启「直播间评论互动数据」权限) | 3.41.0 |
| gift_num | number | 送出的礼物数量 监听 live_gift 消息返回(需要开启「获取礼物互动数据」权限) | 3.41.0 |
| use_follow_action | number | 用户关注变更数据 监听 live_follow 消息返回(需要开启「直播间观众关注状态」权限) | 3.41.0 |
| fansclub_reason_type | number | 粉丝团变更原因 监听 live_fansclub 消息返回(需要开启「获取粉丝团互动数据」权限) | 3.41.0 |
| fansclub_level | number | 粉丝团等级 需要开启「直播间观众粉丝团详细信息」权限后额外返回 | 3.41.0 |
| user_privilege_level | number | 用户荣誉等级 需要开启「直播间观众荣誉等级」权限后额外返回 | 3.41.0 |
| is_follow_anchor | boolean | 用户是否关注主播 需要开启「直播间关注互动数据」权限后额外返回 | 3.41.0 |
返回值
无
代码示例
tt.onReceiveLiveInteractPluginMessage((res) => { console.log('消息数据:', res); });
