预约视频号直播

业务场景

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

参数名称类型说明备注
noticeIdstring预告 id
statusstring预告状态:0 可用 1 取消 2 已用
startTimestring开始时间
headUrlstring直播封面
nicknamestring视频号昵称
reservablestring是否可预约
otherInfosobject其他的预告信息列表

int reserveInfo.state:预约视频号弹窗的回调

说明
1正在直播中,用户点击“取消”拒绝前往直播
2正在直播中,用户点击“允许”前往直播
3预告已取消
4直播已结束
5用户此前未预约,在弹窗中未预约直播直接收起弹窗
6用户此前未预约,在弹窗中预约了直播
7用户此前已预约,在弹窗中取消了预约
8用户此前已预约,直接收起弹窗
9弹窗唤起前用户直接取消
10直播预约已过期

错误码

FAQ