# 删除群发消息

调试诊断

接口应在服务器端调用,不可在前端(小程序、网页、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_tokenstring接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
msg_idnumber发送出去的消息ID
article_idxnumber要删除的文章在图文消息中的位置,第一篇编号为1,该字段不填或填0会删除全部文章
urlstring要删除的文章url,当msg_id未指定时该参数才生效

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息

# 4. 注意事项

  1. msg_idurl中必须有一个参数有传值,当两个参数都有值时只有msg_id有效。
  2. article_idx只有在 msg_id 有传值的时候才生效。
  3. 只有通过 api 发送的并且已经发送成功的消息才能删除。
  4. 删除消息是将消息的图文详情页失效,已经收到的用户,还是能在其本地看到消息卡片。
  5. 删除群发消息只能删除图文消息和视频消息,其他类型的消息一经发送,无法删除。
  6. 如果多次群发发送的是一个图文消息,那么删除其中一次群发,就会删除掉这个图文消息页,导致所有群发都失效。

# 5. 代码示例

请求示例

{
   "msg_id":30124,
   "article_idx":2
}

返回示例

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

# 6. 错误码

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

错误码错误描述解决方案
0okok是指从不正常变成正常 in a normal state是指本来就正常
40001invalid credential  access_token isinvalid or not latestaccess_token 无效或不为最新获取的 access_token,请开发者确认access_token的有效性
40008invalid message type不合法的消息类型
40059invalid msg id参数 msg_id 传参有误
40060invalid article idx删除单篇图文时,指定的 article_idx 不合法
40065invalid msg status文章状态异常,不允许删除
40101missing parameter缺少必填参数
40204can not delete wash or rumor article不允许删除洗稿文或谣言文
41001access_token missing缺少 access_token 参数
42001access_token expiredaccess_token 超时,请检查 access_token 的有效期,请参考基础支持 - 获取 access_token 中,对 access_token 的详细机制说明
45009reach max api daily quota limit超出接口每日调用限制
48001api unauthorizedapi 功能未授权,请确认公众号/服务号已获得该接口,可以在「公众平台官网 - 开发者中心页」中查看接口权限
48004api forbidden for irregularities view detail on mp.weixin.qq.comapi 接口被封禁,请登录 mp.weixin.qq.com 查看详情
50002user limited用户受限,可能是用户帐号被冻结或注销
61004access clientip is not registered第三方平台出口IP未设置
9500001delete same article at the same time稍后再试
268488001system busy, please try later系统繁忙,请稍后再试

# 7. 适用范围

本接口在不同账号类型下的可调用情况:
公众号服务号
仅认证 仅认证
  • 仅认证:表示仅允许企业主体已认证账号调用,未认证或不支持认证的账号无法调用
  • 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;