预约视频号直播
业务场景
C 端用户可以预约官方视频号的直播
适用范围: 微信小游戏
流程图
接口介绍
/**
* 获取视频号直播预告信息
* 【H5】小游戏
*/
SDKManager.channelsLive.getChannelsLiveNoticeInfo(options);
/**
* 预约视频号直播
* 【H5】小游戏
*/
SDKManager.channelsLive.reserveChannelsLive(options);
调用示例
// 获取视频号直播预约信息
// 预约直播
SDKManager.channelsLive.getChannelsLiveNoticeInfo({
onSuccess(channelsLiveNoticeInfo) {
if (channelsLiveNoticeInfo.noticeId && channelsLiveNoticeInfo.status === 0) {
// 【不继承用户点击事件,需要用户重新点击】
// status 预告状态:0可用 1取消 2已用
// 唤起预约直播弹窗
SDKManager.channelsLive.reserveChannelsLive({
noticeId: e.noticeId,
onSuccess(reserveInfo) {
// 由于官方文档没有说返回的具体结构,这里是渠道返回的信息,里面已知的字段目前只有state
// 成功唤起弹窗即为接口调用成功,通过state可以获取用户具体操作行为
},
});
}
},
});
参数说明
出参
ChannelsLiveNoticeInfo channelsLiveNoticeInfo
参数名称 | 类型 | 说明 | 备注 |
---|---|---|---|
noticeId | string | 预告 id | |
status | string | 预告状态:0 可用 1 取消 2 已用 | |
startTime | string | 开始时间 | |
headUrl | string | 直播封面 | |
nickname | string | 视频号昵称 | |
reservable | string | 是否可预约 | |
otherInfos | object | 其他的预告信息列表 |
int reserveInfo.state:预约视频号弹窗的回调
值 | 说明 |
---|---|
1 | 正在直播中,用户点击“取消”拒绝前往直播 |
2 | 正在直播中,用户点击“允许”前往直播 |
3 | 预告已取消 |
4 | 直播已结束 |
5 | 用户此前未预约,在弹窗中未预约直播直接收起弹窗 |
6 | 用户此前未预约,在弹窗中预约了直播 |
7 | 用户此前已预约,在弹窗中取消了预约 |
8 | 用户此前已预约,直接收起弹窗 |
9 | 弹窗唤起前用户直接取消 |
10 | 直播预约已过期 |
错误码
无
FAQ
无