从基础库 2.15.0 开始支持
开发者首先通过wx.getChannelsLiveInfo传入视频号id用于获取视频号直播信息,包括直播id(feedId与nonceId两个参数)与直播状态。
获取直播信息后,开发者可以通过wx.openChannelsLive打开视频号直播。若当前未在直播,则会跳转到最近一场直播的结束页。该接口使用限制如下:
需要用户触发跳转,若用户未点击小程序页面任意位置,则开发者将无法调用此接口。
需要用户确认跳转,在跳转至视频号直播前,将统一增加弹窗,询问是否跳转,用户确认后才可以跳转视频号直播。
小程序内嵌视频号直播
从基础库 2.29.0 开始支持
开发者首先通过wx.getChannelsLiveInfo传入视频号id和起止时间(startTime和endTime参数),用于获取指定时间段的视频号直播信息,包括直播id(feedId)、直播状态和直播回放状态。
获取直播信息后,开发者可以通过channel-live在小程序中展示直播封面,用户点击后可无弹窗直接跳转至视频号直播。不同的直播状态,跳转至视频号的承接页页有所不同,具体如下:
直播未开始:上一场直播的结束页
直播中:直播页面
直播已结束(无回放):直播结束页
直播已结束(有回放):直播回放页
小程序内发起预约视频号直播
从基础库 2.19.0 开始支持
开发者首先通过wx.getChannelsLiveNoticeInfo传入视频号id用于获取视频号直播预告id(noticeId),若当前没有可预约的直播预告,将返回失败。
获取直播预告信息后,开发者可以通过wx.reserveChannelsLive唤起预约弹窗,用户可以进行预约操作。成功唤起弹窗即为接口调用成功,通过state可以获取用户具体操作行为:
state = 1,正在直播中,用户点击“取消”拒绝前往直播
state = 2,正在直播中,用户点击“允许”前往直播
state = 3,预告已取消
state = 4,直播已结束
state = 5,用户此前未预约,在弹窗中未预约直播直接收起弹窗
state = 6,用户此前未预约,在弹窗中预约了直播
state = 7,用户此前已预约,在弹窗中取消了预约
state = 8,用户此前已预约,直接收起弹窗
state = 9,弹窗唤起前用户直接取消
state = 10,直播预约已过期
使用规范
wx.getChannelsLiveInfo与wx.getChannelsLiveNoticeInfo会调用到微信后台系统资源,为了保护系统,开发者请遵守《接口调用频率规范》对接口做适度的频率限制,不能无节制地调用。
平台将坚决打击诱导跳转视频号直播、诱导预约视频号直播等行为,使用此功能时请严格遵守《微信小程序平台运营规范》。
注意事项
该接口在开发版与体验版中均可调用。开发者在调试过程中,可以在视频号选择可见范围进行开播,方便测试。
若小程序与视频号主体信息不一致,会返回100008错误码。
wx.getChannelsLiveInfo与wx.getChannelsLiveNoticeInfo回调函数不继承用户点击事件,无法在wx.getChannelsLiveInfo的success回调中再调用wx.openChannelsLive。
开发者工具暂未支持此能力,请先使用真机调试。