tt.getLiveRoomGiftPool
基础库 3.41.0 开始支持本方法,这是一个异步方法。
用于获取直播间互动礼物信息。
| 前提条件 | 需要在抖音开放平台创建插件,并申请「获取礼物互动数据」权限 |
| 业务背景 | 无 |
| 使用限制 | 无 |
| 注意事项 | 无 |
| 支持沙盒 | 否 |
| 相关教程 | 无 |
语法
tt.getLiveRoomGiftPool(options)
参数说明
options 为 object 类型,属性如下:
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| success | function | 否 | 接口调用成功的回调函数 | 3.41.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 3.41.0 | |
| complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 3.41.0 |
回调成功
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "getLiveRoomGiftPool:ok" | 3.41.0 |
| gift_pool | array | 直播间互动礼物池信息 | 3.41.0 |
gift_pool 类型说明
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| gift_icon | string | 礼物图标 | 3.41.0 |
| gift_name | string | 礼物名字 | 3.41.0 |
| gift_value | number | 礼物价值 | 3.41.0 |
| sec_gift_id | string | 加密的礼物 id | 3.41.0 |
回调失败
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "getLiveRoomGiftPool:fail " + 错误信息 | 3.41.0 |
错误码
| errNo | errMsg | 说明 | 最低支持版本 |
|---|---|---|---|
| 21321 | permission denied | 无权限 | 3.41.0 |
| 21322 | frequent requests, please try again later | 频繁请求 | 3.41.0 |
| 21323 | fail to request open room data | 接口请求失败 | 3.41.0 |
| 21324 | do not get room data before creating a live card | 玩法卡片未创建 | 3.41.0 |
代码示例
tt.getLiveRoomGiftPool({ success(res) { console.log('调用成功:', res.gift_pool); }, fail(err) { console.log('调用失败:', err.errMsg); } });
