视频号活动

从基础库 2.21.0 开始支持

如果微信小程序与视频号的主体相同,或者是关联主体,就可以通过 wx.openChannelsEvent 跳转到视频号发起的活动。

主体判断逻辑

如果微信小程序与视频号的主体相同,那么可以直接调用相关接口。 如果微信小程序与视频号的主体不同,需要同时满足以下 3 个条件才能调用相关接口:

  1. 微信小程序绑定了微信开放平台账号
  2. 微信小程序与微信开放平台账号的关系为同主体或关联主体
  3. 微信开放平台账号的主体与关联主体列表中包含视频号的主体 关联主体申请流程可以参考:https://kf.qq.com/faq/190726e6JFja190726qMJBn6.html

参数获取

finderUserName 表示视频号 ID,要获取视频号 ID,需要登录视频号助手,在首页可以查看自己的视频号 ID。

eventId 是唯一标识某一个活动的 ID,要获取活动的 eventId,需要登录视频号助手,在「内容管理」-「活动管理」模块可以复制自己发起的每个活动对应的 eventId。

视频号直播

若微信小程序与视频号的主体相同或为关联主体,可以跳转到视频号直播间或在微信小程序内发起视频号直播预约。

主体判断

主体信息查询

微信小程序主体信息可通过微信小程序资料页-开发团队进行查询,视频号主体信息可通过视频号首页-认证进行查询。

视频号id需通过视频号助手获取。

主体判断逻辑

若微信小程序与视频号的主体相同,则可以调用相关接口。 若微信小程序与视频号的主体不同,需同时满足以下3个条件则可以调用相关接口:

  1. 微信小程序绑定了微信开放平台账号
  2. 微信小程序与微信开放平台账号的关系为同主体或关联主体
  3. 微信开放平台账号的主体与关联主体列表中包含视频号的主体 关联主体申请流程可以参考:https://kf.qq.com/faq/190726e6JFja190726qMJBn6.html

获取视频号直播信息

开发者可以通过wx.getChannelsLiveInfo接口获取视频号直播id、直播状态、直播主题、视频号头像昵称等直播信息,具体使用方法如下:

从基础库 2.15.0 开始支持

开发者传入视频号id(finderUserName参数),可获取当前或最近一次直播的直播信息,具体如下:

  • status=2,直播中:返回的feedId与nonceId为当前直播id,description为当前直播主题
  • status=3,直播已结束:返回的feedId与nonceId为最近一次直播id,description为最近一次直播主题

从基础库 2.29.0 开始支持

开发者上传视频号id(finderUserName参数)和起止时间(startTime和endTime参数),获取指定时间段内的全部直播信息。其中正在直播或最近一场的直播信息会直接在出参中返回,其余直播信息会在otherInfos中以列表形式返回。

使用方法

微信小程序跳转视频号直播间

从基础库 2.15.0 开始支持

  1. 开发者首先通过wx.getChannelsLiveInfo传入视频号id用于获取视频号直播信息,包括直播id(feedId与nonceId两个参数)与直播状态。

  2. 获取直播信息后,开发者可以通过wx.openChannelsLive打开视频号直播。若当前未在直播,则会跳转到最近一场直播的结束页。该接口使用限制如下:

  • 需要用户触发跳转,若用户未点击微信小程序页面任意位置,则开发者将无法调用此接口。
  • 需要用户确认跳转,在跳转至视频号直播前,将统一增加弹窗,询问是否跳转,用户确认后才可以跳转视频号直播。

微信小程序内嵌视频号直播

从基础库 2.29.0 开始支持

  1. 开发者首先通过wx.getChannelsLiveInfo传入视频号id和起止时间(startTime和endTime参数),用于获取指定时间段的视频号直播信息,包括直播id(feedId)、直播状态和直播回放状态。

  2. 获取直播信息后,开发者可以通过channel-live在微信小程序中展示直播封面,用户点击后可无弹窗直接跳转至视频号直播。不同的直播状态,跳转至视频号的承接页页有所不同,具体如下:

  • 直播未开始:上一场直播的结束页
  • 直播中:直播页面
  • 直播已结束(无回放):直播结束页
  • 直播已结束(有回放):直播回放页

微信小程序内发起预约视频号直播

从基础库 2.19.0 开始支持

  1. 开发者首先通过wx.getChannelsLiveNoticeInfo传入视频号id用于获取视频号直播预告id(noticeId),若当前没有可预约的直播预告,将返回失败。

  2. 获取直播预告信息后,开发者可以通过wx.reserveChannelsLive唤起预约弹窗,用户可以进行预约操作。成功唤起弹窗即为接口调用成功,通过state可以获取用户具体操作行为:

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

使用规范

  1. wx.getChannelsLiveInfo与wx.getChannelsLiveNoticeInfo会调用到微信后台系统资源,为了保护系统,开发者请遵守《接口调用频率规范》对接口做适度的频率限制,不能无节制地调用。
  2. 平台将坚决打击诱导跳转视频号直播、诱导预约视频号直播等行为,使用此功能时请严格遵守《微信小程序平台运营规范》

注意事项

  1. 该接口在开发版与体验版中均可调用。开发者在调试过程中,可以在视频号选择可见范围进行开播,方便测试。
  2. 若微信小程序与视频号主体信息不一致,会返回100008错误码。
  3. wx.getChannelsLiveInfo与wx.getChannelsLiveNoticeInfo回调函数不继承用户点击事件,无法在wx.getChannelsLiveInfo的success回调中再调用wx.openChannelsLive。
  4. 开发者工具暂未支持此能力,请先使用真机调试。

微信小程序打开视频号视频

为满足不同开发者的诉求,微信小程序提供2种打开视频号视频的方式:

  1. 跳转打开视频号视频:无主体限制

  2. 内嵌视频号视频:

  • 从基础库版本2.25.1至2.31.1,微信小程序需与视频号视频相同主体或关联主体
  • 从基础库版本2.31.1开始,非个人主体微信小程序可内嵌非同主体/关联主体视频号视频

获取参数

finderUserName

代表视频号ID,获取视频号ID需要登录视频号助手,在首页可以查看自己的视频号ID。

feedId

代表视频号视频的唯一标识,获取视频的feedId需要登录视频号助手,在「动态管理」模块可以复制自己发表的每个视频对应的feedId。

feed-token

从基础库 2.31.1 开始支持

代表非同主体视频号视频的标识,非个人主体微信小程序可以通过channel-video组件,在微信小程序中内嵌非同主体视频号的视频。

获取feed-token步骤如下:

  1. 登陆MP平台,在「设置-基本设置-隐私与安全」找到「获取视频号视频ID权限」,并将开关打开

  2. 移动端找到想要内嵌的视频号视频,并复制该视频的feed-token,图示如下:

使用该能力时,开发者需要注意:

  1. 时间限制:打开开关后24小时内生效,失效后移动端将不展示「在微信小程序中引用该视频」的入口,如要继续获取,则需要再次打开开关;

  2. 生效范围:开关打开状态仅对当前操作者生效。即上述步骤1和步骤2需为同一操作者,若开发者A在MP平台中打开「获取视频号视频ID权限」开关,仅有A能够在移动端能够复制视频号视频的feed-token,同微信小程序的其他开发者移动端不展示「在微信小程序中引用该视频」入口

使用方法

跳转打开视频号视频

从基础库 2.19.2 开始支持

微信小程序可以通过wx.openChannelsActivity接口跳转到指定视频号的视频页观看视频,无主体要求。

内嵌视频号视频

从基础库 2.25.1 开始支持

微信小程序可以通过channel-video组件在微信小程序中内嵌视频号视频,且支持无弹窗跳转打开视频号对应视频,使用该组件时需注意:

  1. 组件调用无资质要求
  2. 暂不支持纯图片视频号内容
  3. 基础库2.31.1之前,仅可引用和微信小程序同主体或关联主体的视频号视频,从基础库2.31.1开始,支持非个人主体微信小程序内嵌非同主体或关联主体的视频号视频

主体判断

主体信息查询

微信小程序主体信息可通过微信小程序资料页-开发团队进行查询,视频号主体信息可通过视频号首页-认证进行查询。

主体判断逻辑

若微信小程序与视频号的主体相同,则可以调用相关接口。 若微信小程序与视频号的主体不同,需同时满足以下3个条件则可以调用相关接口:

  1. 微信小程序绑定了微信开放平台账号
  2. 微信小程序与微信开放平台账号的关系为同主体或关联主体
  3. 微信开放平台账号的主体与关联主体列表中包含视频号的主体 关联主体申请流程可以参考:https://kf.qq.com/faq/190726e6JFja190726qMJBn6.html

视频号主页

从基础库 2.21.2 开始支持

从2023年12月20日起,通过wx.openChannelsUserProfile跳转到视频号主页将不再受主体限制,使用此功能时请注意遵守运营规范。

如果微信小程序与视频号的主体相同或为关联主体,可以通过 wx.openChannelsUserProfile 跳转到视频号主页。

## 主体判断逻辑

如果微信小程序与视频号的主体相同,则可以调用相关接口。 如果微信小程序与视频号的主体不同,需同时满足以下3个条件则可以调用相关接口: 1. 微信小程序绑定了微信开放平台账号 2. 微信小程序与微信开放平台账号的关系为同主体或关联主体 3. 微信开放平台账号的主体与关联主体列表中包含视频号的主体 关联主体申请流程可以参考:https://kf.qq.com/faq/190726e6JFja190726qMJBn6.html

参数获取

finderUserName表示视频号ID,获取视频号ID需要登录视频号助手,在首页可以查看自己的视频号ID。