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

tt.getLiveRoomGiftPool

收藏
我的收藏

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

用于获取直播间互动礼物信息。

前提条件

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

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

语法

tt.getLiveRoomGiftPool(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
successfunction
接口调用成功的回调函数
3.41.0
failfunction
接口调用失败的回调函数
3.41.0
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)
3.41.0

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"getLiveRoomGiftPool:ok"
3.41.0
gift_poolarray
直播间互动礼物池信息
3.41.0

gift_pool 类型说明

object 类型,属性如下:

属性名类型说明最低支持版本
gift_iconstring
礼物图标
3.41.0
gift_namestring
礼物名字
3.41.0
gift_valuenumber
礼物价值
3.41.0
sec_gift_idstring
加密的礼物 id
3.41.0

回调失败

object 类型,属性如下:

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

错误码

errNoerrMsg说明最低支持版本
21321permission denied
无权限
3.41.0
21322frequent requests, please try again later
频繁请求
3.41.0
21323fail to request open room data
接口请求失败
3.41.0
21324do 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); } });