# 申请开通直播

调试诊断

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:applyLivelnfo

通过该接口,第三方开发者可帮助商家发起小程序直播功能的申请。使用过程中如遇到问题,可在开放平台服务商专区发帖交流。

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/wxa/business/applyliveinfo?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:52

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 authorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
actionstring填:“apply”

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber0代表申请已经受理,等待小程序管理员操作;2表示小程序近90天没有存在支付行为,不能申请开通直播能力。(数据生效时间为T+1,请耐心等待)
errmsgstring错误信息
actionstring"apply"

# 4. 注意事项

# 调用频率

  • 100次/一天

# 服务商使用流程

1、服务商获取商家的小程序直播权限授权(权限集ID:52),授权流程参考授权流程技术说明

2、服务商调用接口【直播功能申请api】帮助商家发起小程序直播权限的申请。

3、平台向小程序管理微信下发模板消息。管理员需在24 小时内点击消息,进行确认同意《微信小程序直播功能服务条款》;

4、商家确认开通成功后,相关通知会通过消息与事件接收 URL 推送给服务商。

5、开通了直播之后,服务商可以调用其他直播的接口进行直播管理,详情可查看“小程序文档中心-服务端-直播”的接口文档

# 商家使用流程

1、服务商调用接口后,小程序管理员将收到【公众平台安全助手】服务号推送的模板消息。

2、24小时内点击消息卡片进入功能开通页面,阅读并同意《微信小程序直播功能服务条款》后,提交功能申请。超时未进行功能申请,则本次申请失效。

3、申请提交后将实时反馈申请结果。

# 报错 268489001

1、目前处于系统维护阶段,暂时不支持新增开通直播权限了(已经有直播权限的账号不影响);当前开发者如果有直播的需求可以试试视频号直播,小程序内也可以跳转视频号直播间,能力文档如下: 视频号直播

# 其他说明

结果推送示例

开通结果会向消息与事件接收 URL 推送相关通知。

数据示例

<xml>
  <ToUserName><![CDATA[toUser]]></ToUserName>
  <FromUserName><![CDATA[fromUser]]></FromUserName>
  <CreateTime>时间戳</CreateTime>
  <MsgType><![CDATA[event]]></MsgType>
  <Event><![CDATA[wxa_live_apply_event]]></Event>
  <ApplyLiveInfoNoitfy>
    <appid>![CDATA[成功开通的appid]]</appid>
    <open_time>![CDATA[成功开通的时间]]</open_time>
  </ApplyLiveInfoNoitfy>
</xml>

# 5. 代码示例

请求示例

{
  "action": "apply"
}

返回示例

{
  "errcode": 0,
  "errmsg": "ok",
  "action": "apply"
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

错误码错误描述解决方案
-1system error系统繁忙,此时请开发者稍候再试
2小程序近90天没有存在支付行为,不能申请开通直播能力。(数据生效时间为T+1,请耐心等待)
268489001小程序直播系统维护中,暂停申请权限。请查看接口文档注意事项说明

# 7. 适用范围

本接口支持「第三方平台」账号类型代调用,权限集请参考「调用方式」部分。其他账号类型如无特殊说明,均不可调用。