小程序邀请
适用平台
| 平台 | 是否适用 |
|---|---|
| 虎牙直播PC主播端 | 是 |
| 虎牙助手APP | 是 |
介绍
针对小程序平台上部分主播对抗类的小程序，平台提供了一套SDK接口，让开发者可方便的实现主播与主播之间的邀请功能。
功能时序图
该时序图是以完成一次两个主播PK的邀请流程，里面的业务服务器指的是小程序的后端服务器。
接口说明
该接口基于小程序SDK的通用上行接口来使用
| 关键字 | 说明 |
|---|---|
| inviteCapability.inviteProfile | 向另外一位主播发起小程序邀请 |
说明：
该接口需要分配接口权限，使用前请联系官方；
单次最大同时邀请主播数10个；
只能邀请当前正在直播的主播；
邀请行为有冷却时间，单次邀请后1分钟内不能重复发起邀请。
参数：
| 字段 | 类型 | 说明 |
|---|---|---|
| roomNumbers | string | 需要邀请的主播房间号，多个用英文逗号分隔 |
| passParam | map<string, string> | 自定义消息结构，发送邀请后该内容可以通过SDK中hyExt.env.getInitialParam接口获取到 |
返回参数：
成功时
无
失败时
| 字段 | 类型 | 说明 |
|---|---|---|
| res | string | 失败状态码 |
| message | string | 错误提示 |
| 状态码 | 说明 |
|---|---|
0 | 成功 |
1 | 参数缺少/错误 |
2 | 调用异常，请重试 |
11 | 接口权限未授权 |
12 | 频率超出 |
13 | 消息内容超大 |
14 | 该主播没有安装小程序 |
15 | 存在暂未结束的邀请 |
16 | 主播邀请人数超过上限 |
17 | 邀请已结束 |
18 | 主播信息不存在 |
19 | 该小程序命中下发规则，请联系管理员 |
20 | 对方主播不在播 |
21 | 对方设备暂不支持 |
22 | 对方版本太低，暂不支持 |