# 删除群发消息
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:deleteMassMsg
群发之后,随时可以通过该接口删除群发。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cgi-bin/message/mass/delete?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:7
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
msg_id | number | 否 | 发送出去的消息ID |
article_idx | number | 是 | 要删除的文章在图文消息中的位置,第一篇编号为1,该字段不填或填0会删除全部文章 |
url | string | 否 | 要删除的文章url,当msg_id未指定时该参数才生效 |
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
# 4. 注意事项
- msg_id和url中必须有一个参数有传值,当两个参数都有值时只有msg_id有效。
- article_idx只有在msg_id有传值的时候才生效。
- 只有通过api发送的并且已经发送成功的消息才能删除。
- 删除消息是将消息的图文详情页失效,已经收到的用户,还是能在其本地看到消息卡片。
- 删除群发消息只能删除图文消息和视频消息,其他类型的消息一经发送,无法删除。
- 如果多次群发发送的是一个图文消息,那么删除其中一次群发,就会删除掉这个图文消息页,导致所有群发都失效。
# 5. 代码示例
请求示例
{
"msg_id":30124,
"article_idx":2
}
返回示例
{
"errcode":0,
"errmsg":"ok"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
0 | ok | ok是指从不正常变成正常 in a normal state是指本来就正常 |
# 7. 适用范围
本接口在不同账号类型下的可调用情况:
公众号 | 服务号 |
---|---|
仅认证 | 仅认证 |
- 仅认证:表示仅允许企业主体已认证账号调用,未认证或不支持认证的账号无法调用
- 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;