互动指令
一、功能介绍
该组件提供了一套完整的互动指令能力，使开发者直接使用小程序SDK就可实现一个观众端快捷互动面板
图1：APP观众端
图2：WEB观众端指令面板
图3：WEB观众端指令面板
二、接入流程
1、申请权限
联系平台管理员或邮件到hy-ext@huya.com申请开通互动指令相关权限
2、配置指令素材
访问开发者中心找到对应的小程序，进入“互动指令”菜单。 如图下所示：
图4：开发者中心配置后台
3、接口对接
(1)、时序图
图5：交互时序图
(2)、使用说明
- 该组件目前提供的是小程序SDK接口，请通过该SDK接口触发SDK接口-通用上行
- 心跳接口开启后保持一定间隔（10s）触发调用
- 心跳停止后最长一分钟观众端面板会消失
(3)、对局开启接口
- 接口调用说明
key参数：interactiveCapability.battleStart
- param参数，是用json格式提交
| 参数名称 | 类型 | 备注 |
|---|---|---|
| battleId | string | 必填，对局id，使用小写数字字母，不能超过32个字符 |
| commandUuid | string | 必填，指令uuid，开发中中心配置后生成 |
- 响应
没有返回值
(4)、对局关闭接口
- 接口调用说明
key参数：interactiveCapability.battleClose
- param参数，是用json格式提交
| 参数名称 | 类型 | 备注 |
|---|---|---|
| battleId | string | 必填，对局id，使用小写数字字母，不能超过32个字符 |
- 响应
没有返回值
(5)、对局心跳接口
- 接口调用说明
key参数：interactiveCapability.battleHeartbeat
- param参数，是用json格式提交
| 参数名称 | 类型 | 备注 |
|---|---|---|
| battleId | string | 必填，对局id，使用小写数字字母，不能超过32个字符 |
- 响应
没有返回值
附录：支持的礼物列表
| 礼物id | 礼物名称 | 礼物价值 | 礼物图标 |
|---|---|---|---|
| 4 | 虎粮 | 0.1虎牙币 |  |
| 20206 | 荧光棒 | 0.1虎牙币 |  |
| 20571 | 粉丝牌 | 1虎牙币 |  |
| 20493 | 糖豆车 | 6.6虎牙币 |  |
| 20273 | 火锅 | 66虎牙币 |  |
| 20279 | 高能预警 | 88虎牙币 |  |
| 20271 | 魔法书 | 99虎牙币 |  |
| 20267 | 钞票枪 | 300虎牙币 |  |
| 20269 | 虎牙一号 | 1000虎牙币 |  |