# 发送直播开始事件
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:pushMessage
该接口用于向长期订阅用户群发直播间开始事件。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/business/push_message?access_token=ACCESS_TOKEN
# 云调用
调用方法:liveBroadcast.pushMessage
出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:52
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| room_id | number | 是 | 直播开始事件的房间ID |
| user_openid | array | 是 | 接收该群发开播事件的订阅用户OpenId列表 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| message_id | string | 此次群发消息的标识ID,用于对应【长期订阅群发结果回调】的message_id |
| errcode | number | 接口返回码,0表示成功,非0则失败。若errcode=0仅表明触发接口成功,最终群发结果请看【长期订阅群发结果回调】 |
| errmsg | string | 接口返回提示信息 |
# 4. 注意事项
调用额度:5000次/一天;群发订阅用户个数限制:2000/次
# 5. 代码示例
请求示例
{
"room_id": 1,
"user_openid": [
"openid1",
"openid2"
]
}
返回示例
{ "message_id":"message_id", "errcode": 0, "errmsg": "ok", }
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 9410005 | 当日另外一个房间已推送过 | |
| 9410006 | 推送的直播间非直播中状态 |
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请已实际调用情况为准。