# 发送直播开始事件
接口应在服务器端调用,详细说明参见服务端API。
本接口支持云调用。需开发者工具版本 >=
1.02.1904090
(最新稳定版下载),wx-server-sdk
>=0.4.0
# 接口说明
# 接口英文名
pushMessage
# 功能描述
该接口用于向长期订阅用户群发直播间开始事件。
# 注意事项
调用额度:5000次/一天;群发订阅用户个数限制:2000/次
# 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/business/push_message?access_token=ACCESS_TOKEN
# 云调用
出入参和HTTPS调用相同,调用方式可查看云调用说明文档
接口方法为: openapi.liveBroadcast.pushMessage
# 第三方调用
调用方式以及出入参和HTTPS相同,仅是调用的token不同
该接口所属的权限集id为:52
服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用
# 请求参数含义
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
room_id | Number | 是 | 直播开始事件的房间ID |
user_openid | Array<String> | 是 | 接收该群发开播事件的订阅用户OpenId列表 |
# 返回参数含义
参数 | 说明 |
---|---|
message_id | 此次群发消息的标识ID,用于对应【长期订阅群发结果回调】的message_id |
errcode | 接口返回码,0表示成功,非0则失败。若errcode=0仅表明触发接口成功,最终群发结果请看【长期订阅群发结果回调】 |
errmsg | 接口返回提示信息 |
# 调用示例
示例说明: HTTPS请求示例
# 请求数据示例
{
"room_id": 1,
"user_openid":["openid1", "openid2"]
}
# 返回数据示例
{
"message_id":"message_id",
"errcode": 0,
"errmsg": "ok",
}
# 错误码
错误码 | 错误码取值 | 解决方案 |
---|---|---|
9410005 | 当日另外一个房间已推送过 | |
9410006 | 推送的直播间非直播中状态 |