tt.unsubscribeLiveInteractPluginMessage
收藏
我的收藏基础库 3.41.0 开始支持本方法,这是一个异步方法。
用于取消订阅直播间开放消息数据。
前提条件 | 需要在抖音开放平台创建插件,并申请「互动数据」权限 |
业务背景 | 无 |
使用限制 | 无 |
注意事项 | 无 |
支持沙盒 | 否 |
相关教程 | 无 |
语法
tt.unsubscribeLiveInteractPluginMessage(options)
参数说明
options 为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
messageType | Array<string> | 否 | 需要获取的开放消息类型 | 3.41.0 | |
success | function | 否 | 接口调用成功的回调函数 | 3.41.0 | |
fail | function | 否 | 接口调用失败的回调函数 | 3.41.0 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 3.41.0 |
messageType 参数说明
MessageType 是个数组,数组中可以传以下枚举:
Enum | 说明 | 对应能力申请 |
live_like | 获取点赞互动数据 | |
live_comment | 获取直播间评论互动数据 | |
live_gift | 获取礼物互动数据 | |
live_follow | 获取直播间观众关注状态 | |
live_fansclub | 获取粉丝团互动数据 |
回调成功
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "unsubscribeLiveInteractPluginMessage:ok" | 3.41.0 |
回调失败
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "unsubscribeLiveInteractPluginMessage:fail " + 错误信息 | 3.41.0 |
错误码
errNo | errMsg | 说明 | 最低支持版本 |
---|---|---|---|
21308 | permission denied | 无权限 | 3.41.0 |
21309 | fail to request unsubscribe message | stop_im_task接口请求失败 | 3.41.0 |
21310 | do not unsubscribe messages before creating a live card | 卡片未创建 | 3.41.0 |
代码示例
tt.unsubscribeLiveInteractPluginMessage({ messageType: ['live_like', 'live_comment'], success(res) { console.log('调用成功:', res); }, fail(err) { console.log('调用失败:', err); } });
点击纠错