高级群发接口

出自中南e行公众平台开发者文档

跳转到：导航, 搜索

在公众平台网站上，为订阅号提供了每天一条的群发权限，为服务号提供每月（自然月）4条的群发权限。而对于某些具备开发能力的公众号运营者，可以通过高级群发接口，实现更灵活的群发能力。

{
   "articles": [
		 {
                        "thumb_media_id":"qI6_Ze_6PtV7svjolgs-rN6stStuHIjs9_DidOHaj0Q-mwvBelOXCFZiq2OsIU-p",
                        "author":"xxx",
			 "title":"Happy Day",
			 "content_source_url":"http://www.csu.edu.cn/",
			 "content":"content",
			 "digest":"digest",
                        "show_cover_pic":"1"
		 },
		 {
                        "thumb_media_id":"qI6_Ze_6PtV7svjolgs-rN6stStuHIjs9_DidOHaj0Q-mwvBelOXCFZiq2OsIU-p",
                        "author":"xxx",
			 "title":"Happy Day",
			 "content_source_url":"http://www.csu.edu.cn/",
			 "content":"content",
			 "digest":"digest",
                        "show_cover_pic":"0"
		 }
   ]
}

参数	是否必须	说明
Articles	是	图文消息，一个图文消息支持1到10条图文
thumb_media_id	是	图文消息缩略图的media_id，可以在基础支持-上传多媒体文件接口中获得
author	否	图文消息的作者
title	是	图文消息的标题
content_source_url	否	在图文消息页面点击“阅读原文”后的页面
content	是	图文消息页面的内容，支持HTML标签
digest	否	图文消息的描述
show_cover_pic	否	是否显示封面，1为显示，0为不显示

返回说明

返回数据示例（正确时的JSON返回结果）：

{
   "type":"news",
   "media_id":"CsEf3ldqkAYJAU6EJeIkStVDSvffUJ54vqbThMgplD-VJXXof6ctX5fI6-aYyUiQ",
   "created_at":1391857799
}

参数	说明
type	媒体文件类型，分别有图片（image）、语音（voice），次数为news，即图文消息
media_id	媒体文件/图文消息上传后获取的唯一标识
created_at	媒体文件上传时间

错误时中南e行会返回错误码等信息，请根据错误码查询错误信息: 全局返回码说明

根据分组进行群发

接口调用请求说明

http请求方式: POST
http://app.its.csu.edu.cn/mqtt/cgi-bin/message/mass/sendall?access_token=ACCESS_TOKEN

POST数据说明

POST数据示例如下：

图文消息（注意图文消息的media_id需要通过上述方法来得到）：

{
   "filter":{
      "is_to_all":false
      "group_id":"2"
   },
   "mpnews":{
      "media_id":"123dsdajkasd231jhksad"
   },
    "msgtype":"mpnews"
}

文本：

{
   "filter":{
      "is_to_all":false
      "group_id":"2"
   },
   "text":{
      "content":"CONTENT"
   },
    "msgtype":"text"
}

语音（注意此处media_id需通过基础支持中的上传下载多媒体文件来得到）：

{
   "filter":{
      "is_to_all":false
      "group_id":"2"
   },
   "voice":{
      "media_id":"123dsdajkasd231jhksad"
   },
    "msgtype":"voice"
}

图片（注意此处media_id需通过基础支持中的上传下载多媒体文件来得到）：

{
   "filter":{
      "is_to_all":false
      "group_id":"2"
   },
   "image":{
      "media_id":"123dsdajkasd231jhksad"
   },
    "msgtype":"image"
}

参数	是否必须	说明
filter	是	用于设定图文消息的接收者
is_to_all	否	用于设定是否向全部用户发送，值为true或false，选择true该消息群发给所有用户，选择false可根据group_id发送给指定群组的用户
group_id	否	群发到的分组的group_id，参加用户管理中用户分组接口，若is_to_all值为true，可不填写group_id
mpnews	是	用于设定即将发送的图文消息
media_id	是	用于群发的消息的media_id
msgtype	是	群发的消息类型，图文消息为mpnews，文本消息为text，语音为voice，图片为image
title	否	消息的标题
description	否	消息的描述

返回说明

返回数据示例（正确时的JSON返回结果）：

{
   "errcode":0,
   "errmsg":"send job submission success",
   "msg_id":34182
}

参数	说明
type	媒体文件类型，分别有图片（image）、语音（voice），图文消息为news
errcode	错误码
errmsg	错误信息
msg_id	消息ID

请注意：在返回成功时，意味着群发任务提交成功，并不意味着此时群发已经结束，所以，仍有可能在后续的发送过程中出现异常情况导致用户未收到消息，如消息有时会进行审核、服务器不稳定等。此外，群发任务一般需要较长的时间才能全部发送完毕，请耐心等待。

错误时中南e行会返回错误码等信息，请根据错误码查询错误信息: 全局返回码说明

根据OpenID列表群发

接口调用请求说明

http请求方式: POST
http://app.its.csu.edu.cn/mqtt/cgi-bin/message/mass/send?access_token=ACCESS_TOKEN

POST数据说明

POST数据示例如下：

图文消息（注意图文消息的media_id需要通过上述方法来得到）：

{
   "touser":[
    "OPENID1",
    "OPENID2"
   ],
   "mpnews":{
      "media_id":"123dsdajkasd231jhksad"
   },
    "msgtype":"mpnews"
}

文本：

{
   "touser":[
    "OPENID1",
    "OPENID2"
   ],
    "msgtype": "text",
    "text": { "content": "hello from boxer."}
}

语音：

{
   "touser":[
    "OPENID1",
    "OPENID2"
   ],
   "voice":{
      "media_id":"mLxl6paC7z2Tl-NJT64yzJve8T9c8u9K2x-Ai6Ujd4lIH9IBuF6-2r66mamn_gIT"
   },
    "msgtype":"voice"
}

图片：

{
   "touser":[
    "OPENID1",
    "OPENID2"
   ],
   "image":{
      "media_id":"BTgN0opcW3Y5zV_ZebbsD3NFKRWf6cb7OPswPi9Q83fOJHK2P67dzxn11Cp7THat"
   },
    "msgtype":"image"
}

参数	是否必须	说明
touser	是	填写图文消息的接收者，一串OpenID列表，OpenID最少个，最多10000个
mpnews	是	用于设定即将发送的图文消息
media_id	是	用于群发的图文消息的media_id
msgtype	是	群发的消息类型，图文消息为mpnews，文本消息为text，语音为voice，图片为image
title	否	消息的标题
description	否	消息的描述

返回说明

返回数据示例（正确时的JSON返回结果）：

{
   "errcode":0,
   "errmsg":"send job submission success",
   "msg_id":34182
}

参数	说明
type	媒体文件类型，分别有图片（image）、语音（voice），次数为news，即图文消息
errcode	错误码
errmsg	错误信息
msg_id	消息ID

请注意：在返回成功时，意味着群发任务提交成功，并不意味着此时群发已经结束，所以，仍有可能在后续的发送过程中出现异常情况导致用户未收到消息，如消息有时会进行审核、服务器不稳定等。此外，群发任务一般需要较长的时间才能全部发送完毕，请耐心等待。

错误时中南e行会返回错误码等信息，请根据错误码查询错误信息: 全局返回码说明

删除群发

接口调用请求说明

http请求方式: POST
http://app.its.csu.edu.cn/mqtt/cgi-bin/message/mass/delete?access_token=ACCESS_TOKEN

POST数据说明

POST数据示例如下：

{
   "msg_id":30124
}

参数	是否必须	说明
msg_id	是	发送出去的消息ID

请注意，只有已经发送成功的消息才能删除删除消息只是将消息的图文详情页失效，已经收到的用户，还是能在其本地看到消息卡片。 另外，删除群发消息只能删除图文消息，其他类型的消息一经发送，无法删除。

返回说明

返回数据示例（正确时的JSON返回结果）：

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

参数	说明
errcode	错误码
errmsg	错误信息

错误时中南e行会返回错误码等信息，请根据错误码查询错误信息: 全局返回码说明

事件推送群发结果

由于群发任务提交后，群发任务可能在一定时间后才完成，因此，群发接口调用时，仅会给出群发任务是否提交成功的提示，若群发任务提交成功，则在群发任务结束时，会向开发者在公众平台填写的开发者URL（callback URL）推送事件。

推送的XML结构如下（发送成功时）：

<xml>
<ToUserName><![CDATA[gh_3e8adccde292]]></ToUserName>
<FromUserName><![CDATA[oR5Gjjl_eiZoUpGozMo7dbBJ362A]]></FromUserName>
<CreateTime>1394524295</CreateTime>
<MsgType><![CDATA[event]]></MsgType>
<Event><![CDATA[MASSSENDJOBFINISH]]></Event>
<MsgID>1988</MsgID>
<Status><![CDATA[sendsuccess]]></Status>
<TotalCount>100</TotalCount>
<FilterCount>80</FilterCount>
<SentCount>75</SentCount>
<ErrorCount>5</ErrorCount>
</xml>

参数	说明
ToUserName	公众号的中南e行号
FromUserName	公众号群发助手的中南e行号，为mphelper
CreateTime	创建时间的时间戳
MsgType	消息类型，此处为event
Event	事件信息，此处为MASSSENDJOBFINISH
MsgID	群发的消息ID
Status	群发的结构，为“send success”或“send fail”或“err(num)”。但send success时，也有可能因用户拒收公众号的消息、系统错误等原因造成少量用户接收失败。err(num)是审核失败的具体原因，可能的情况如下： err(10001), //涉嫌广告 err(20001), //涉嫌政治 err(20004), //涉嫌社会 err(20002), //涉嫌色情 err(20006), //涉嫌违法犯罪 err(20008), //涉嫌欺诈 err(20013), //涉嫌版权 err(22000), //涉嫌互推(互相宣传) err(21000), //涉嫌其他
TotalCount	group_id下粉丝数；或者openid_list中的粉丝数
FilterCount	过滤（过滤是指特定地区、性别的过滤、用户设置拒收的过滤，用户接收已超4条的过滤）后，准备发送的粉丝数，原则上，FilterCount = SentCount + ErrorCount
SentCount	发送成功的粉丝数
ErrorCount	发送失败的粉丝数

新手接入

基础支持

接收消息

发送消息

用户管理

自定义菜单

推广支持

开发者交流互助

个人工具

名字空间

变换

查看

动作

搜索