虎牙开放平台文档

开放API 协议说明

1.获取直播间礼物素材列表

GET https://open-apiext.huya.com/proxy/index?do=getRoomGiftInfoList

1.1.接口参数

参数名称	类型	描述
appId	string	开发者的appId
roomId	int	房间号
iat	int	jwt签发时间（unix时间戳），即生成sToken的当前unix时间戳
exp	int	jwt过期时间（unix时间戳），通常exp=iat+600，注意不少于当前时间且不超过当前时间60分钟
sToken	string	jwt鉴权生成的token

1.2.返回（JSON）

返回字段

字段名称	类型	描述
code	int	参考下面的接口返回码
message	string	消息提示
data[]["giftId"]	int	礼物id
data[]["giftCnName"]	string	礼物中文名称
data[]["giftEnName"]	string	礼物英文名称
data[]["iconUrl"]	string	图标url
data[]["largeIconUrl"]	string	大图标url
data[]["gifUrl"]	string	gif url
data[]["prizeHyc"]	double	礼物对应虎牙币价格，注：小于0表示该方式不可用
data[]["prizeGoldbean"]	int	礼物对应金豆价格，注：小于0表示该方式不可用
data[]["prizeSilverbean"]	int	礼物对应银豆价格，注：小于0表示该方式不可用

接口返回码

返回码	描述
200	成功
405	房间号输入错误
407	鉴权失败
500	列表不存在
其他	失败

1.3.调用例子

curl "https://open-apiext.huya.com/proxy/index?do=getRoomGiftInfoList&roomId=327362&appId=xxxxxxxxxxxx&iat=1556188391&exp=1556188991&sToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1NTYxODgzOTEsImV4cCI6MTU1NjE4ODk5MSwiYXBwSWQiOiJ4eHh4eHh4eHh4eHgifQ.DFdsMFu_VzPkUUS1eu_Kwyzvc6vSQ-x_HI3wEut72cU"

1.4.接口返回JSON

成功返回

{
code: 200,
message: "成功",
data: [
 {
	"giftId": 20547,
	"giftCnName": "糖果机",
	"giftEnName": "tangguoji",
	"iconUrl": "https://huyaimg.msstatic.com/cdnimage/actprop/20547_1__24_1622275037.jpg",
	"largeIconUrl": "https://huyaimg.msstatic.com/cdnimage/actprop/20547_1__108_1622275877.jpg",
	"gifUrl": "https://huyaimg.msstatic.com/cdnimage/actprop/20547_1__gif_1622275038.gif",
	"prizeHyc": 100000,
	"prizeGoldbean": 1000000,
	"prizeSilverbean": -1
}, {
	"giftId": 20437,
	"giftCnName": "快上车",
	"giftEnName": "junzizhuanshu",
	"iconUrl": "https://huyaimg.msstatic.com/cdnimage/actprop/20437_1__24_1602586720.jpg",
	"largeIconUrl": "https://huyaimg.msstatic.com/cdnimage/actprop/20437_1__108_1602587367.jpg",
	"gifUrl": "https://huyaimg.msstatic.com/cdnimage/actprop/20437_1__gif_1602586722.gif",
	"prizeHyc": 500000,
	"prizeGoldbean": 5000000,
	"prizeSilverbean": -1
}, {
	"giftId": 20429,
	"giftCnName": "樱花雨",
	"giftEnName": "yinghua",
	"iconUrl": "https://huyaimg.msstatic.com/cdnimage/actprop/20429_1__24_1601473074.jpg",
	"largeIconUrl": "https://huyaimg.msstatic.com/cdnimage/actprop/20429_1__108_1601473666.jpg",
	"gifUrl": "https://huyaimg.msstatic.com/cdnimage/actprop/20429_1__gif_1601473076.gif",
	"prizeHyc": 100000,
	"prizeGoldbean": 1000000,
	"prizeSilverbean": -1
}
]
}

失败返回

{
  "code": 500,
  "message": "列表不存在",
  "data": null
}

开放API