高级群发接口
第2行: | 第2行: | ||
接口调用请求说明: | 接口调用请求说明: | ||
− | |||
− | |||
URL:https://m.api.weibo.com/2/messages/sendall?access_token=ACCESS_TOKEN | URL:https://m.api.weibo.com/2/messages/sendall?access_token=ACCESS_TOKEN | ||
− | |||
HTTP 请求方式:POST | HTTP 请求方式:POST | ||
− | |||
授权限制:频次限制是 | 授权限制:频次限制是 | ||
− | |||
POST数据说明: | POST数据说明: | ||
− | ''' | + | '''图文素材''' |
<pre> | <pre> | ||
{ | { | ||
第18行: | 第13行: | ||
"group_id":"123" //分组id | "group_id":"123" //分组id | ||
}, | }, | ||
− | " | + | "news":{ |
− | " | + | "media_id":"XXXXXXXXXX" //通过上传图文消息素材生成的短链 |
}, | }, | ||
− | "msgtype":" | + | "msgtype":"news" |
} | } | ||
</pre> | </pre> | ||
第45行: | 第40行: | ||
}, | }, | ||
"voice":{ | "voice":{ | ||
− | "media_id":"xxxxxxxxx" // | + | "media_id":"xxxxxxxxx" //语音id,通过上传下载多媒体文件来得到 |
}, | }, | ||
"msgtype":"voice" | "msgtype":"voice" | ||
} | } | ||
</pre> | </pre> | ||
− | |||
'''图片''' | '''图片''' | ||
第59行: | 第53行: | ||
}, | }, | ||
"image":{ | "image":{ | ||
− | "media_id":"xxxxxxxxx" // | + | "media_id":"xxxxxxxxx" //图片id,通过上传下载多媒体文件来得到 |
}, | }, | ||
"msgtype":"image" | "msgtype":"image" | ||
第71行: | 第65行: | ||
"group_id":"123" //分组id | "group_id":"123" //分组id | ||
}, | }, | ||
− | + | "articles": [ | |
− | + | { | |
− | + | "display_name": "两个故事", | |
− | "msgtype":" | + | "summary": "今天讲两个故事,分享给你。谁是公司?谁又是中国人?", |
+ | "image": "http://storage.mcp.weibo.cn/0JlIv.jpg", | ||
+ | "url": "http://e.weibo.com/mediaprofile/article/detail?uid=1722052204&aid=983319" | ||
+ | }, | ||
+ | ... //最多支持8个图文,建议为1或3个 | ||
+ | ], | ||
+ | "msgtype":"articles" | ||
} | } | ||
</pre> | </pre> | ||
− | + | //返回说明 | |
+ | 调用成功时的返回值: | ||
<pre> | <pre> | ||
{ | { | ||
− | + | "result": true, | |
− | + | "msg_id": xxxxx //成功返回true,消息ID | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
} | } | ||
</pre> | </pre> | ||
− | + | 调用失败时的返回值: | |
+ | <pre> | ||
{ | { | ||
− | "request": " | + | "request": "https://m.api.weibo.com/2/messages/sendall", |
"errcode": "1000XX", | "errcode": "1000XX", | ||
"errmsg": "error message." | "errmsg": "error message." | ||
} | } | ||
</pre> | </pre> | ||
+ | 请注意:在返回成功时,意味着群发任务提交成功,并不意味着此时群发已经结束,所以,仍有可能在后续的发送过程中出现异常情况导致用户未收到消息,如消息有时会进行审核、服务器不稳定等。此外,群发任务一般需要较长的时间才能全部发送完毕,请耐心等待。 | ||
+ | |||
第103行: | 第103行: | ||
接口调用请求说明: | 接口调用请求说明: | ||
− | |||
− | |||
URL:https://m.api.weibo.com/2/messages/sendall?access_token=ACCESS_TOKEN | URL:https://m.api.weibo.com/2/messages/sendall?access_token=ACCESS_TOKEN | ||
− | |||
HTTP 请求方式:POST | HTTP 请求方式:POST | ||
− | |||
− | |||
POST数据说明: | POST数据说明: | ||
+ | |||
+ | '''图文素材''' | ||
+ | <pre> | ||
+ | { | ||
+ | "touser":[ | ||
+ | "uid1", | ||
+ | "uid2" | ||
+ | ], | ||
+ | "news":{ | ||
+ | "media_id":"XXXXXXXXXX" //通过上传图文消息素材生成的短链 | ||
+ | }, | ||
+ | "msgtype":"news" | ||
+ | } | ||
+ | </pre> | ||
'''文本''' | '''文本''' | ||
<pre> | <pre> | ||
{ | { | ||
− | + | "touser":[ | |
"uid1", | "uid1", | ||
"uid2" | "uid2" | ||
第128行: | 第137行: | ||
</pre> | </pre> | ||
+ | '''语音''' | ||
+ | <pre> | ||
+ | { | ||
+ | "touser":[ | ||
+ | "uid1", | ||
+ | "uid2" | ||
+ | ], | ||
+ | "voice":{ | ||
+ | "media_id":"xxxxxxxxx" //语音id,通过上传下载多媒体文件来得到 | ||
+ | }, | ||
+ | "msgtype":"voice" | ||
+ | } | ||
+ | </pre> | ||
+ | '''图片''' | ||
+ | <pre> | ||
+ | { | ||
+ | "touser":[ | ||
+ | "uid1", | ||
+ | "uid2" | ||
+ | ], | ||
+ | "image":{ | ||
+ | "media_id":"xxxxxxxxx" //图片id,通过上传下载多媒体文件来得到 | ||
+ | }, | ||
+ | "msgtype":"image" | ||
+ | } | ||
+ | </pre> | ||
+ | '''图文消息''' | ||
+ | <pre> | ||
+ | { | ||
+ | "touser":[ | ||
+ | "uid1", | ||
+ | "uid2" | ||
+ | ], | ||
+ | "articles": [ | ||
+ | { | ||
+ | "display_name": "两个故事", | ||
+ | "summary": "今天讲两个故事,分享给你。谁是公司?谁又是中国人?", | ||
+ | "image": "http://storage.mcp.weibo.cn/0JlIv.jpg", | ||
+ | "url": "http://e.weibo.com/mediaprofile/article/detail?uid=1722052204&aid=983319" | ||
+ | }, | ||
+ | ... //最多支持8个图文,建议为1或3个 | ||
+ | ], | ||
+ | "msgtype":"articles" | ||
+ | } | ||
+ | </pre> | ||
+ | //返回说明 | ||
+ | 调用成功时的返回值: | ||
+ | <pre> | ||
+ | { | ||
+ | "result": true, | ||
+ | "msg_id": xxxxx //成功返回true,消息ID | ||
+ | } | ||
+ | </pre> | ||
+ | 调用失败时的返回值: | ||
+ | <pre> | ||
+ | { | ||
+ | "request": "https://m.api.weibo.com/2/messages/sendall", | ||
+ | "errcode": "1000XX", | ||
+ | "errmsg": "error message." | ||
+ | } | ||
+ | </pre> | ||
+ | 请注意:在返回成功时,意味着群发任务提交成功,并不意味着此时群发已经结束,所以,仍有可能在后续的发送过程中出现异常情况导致用户未收到消息,如消息有时会进行审核、服务器不稳定等。此外,群发任务一般需要较长的时间才能全部发送完毕,请耐心等待。 | ||
+ | =删除群发= | ||
+ | 接口调用请求说明: | ||
+ | URL:https://m.api.weibo.com/2/messages/delete?access_token=ACCESS_TOKEN | ||
+ | HTTP 请求方式:POST | ||
+ | 授权限制:频次限制是 | ||
+ | POST数据说明: | ||
+ | <pre> | ||
+ | { | ||
+ | "msgid":12333 | ||
+ | } | ||
+ | </pre> | ||
+ | 请注意,只有已经发送成功的消息才能删除删除消息只是将消息的图文详情页失效,已经收到的用户,还是能在其本地看到消息卡片。 另外,删除群发消息只能删除news和image,其他类型的消息一经发送,无法删除。 | ||
+ | //返回说明 | ||
+ | 调用成功时的返回值: | ||
+ | <pre> | ||
+ | { | ||
+ | "result": true | ||
+ | } | ||
+ | </pre> | ||
+ | 调用失败时的返回值: | ||
+ | <pre> | ||
+ | { | ||
+ | "request": "https://m.api.weibo.com/2/messages/delete", | ||
+ | "errcode": "1000XX", | ||
+ | "errmsg": "error message." | ||
+ | } | ||
+ | </pre> | ||
+ | |||
+ | =事情推送群发结果= | ||
+ | |||
+ | 由于群发任务提交后,群发任务可能在一定时间后才完成,因此,群发接口调用时,仅会给出群发任务是否提交成功的提示,若群发任务提交成功,则在群发任务结束时,会向开发者在粉丝服务平台填写的开发者URL(callback URL)推送事件。 | ||
+ | |||
+ | |||
+ | 推送的XML结构如下(发送成功时): | ||
+ | |||
+ | <pre> | ||
+ | <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> | ||
+ | </pre> | ||
{| border="1" cellspacing="0" cellpadding="0" width="100%" class="parameters" style="border-color: #CCCCCC;" | {| border="1" cellspacing="0" cellpadding="0" width="100%" class="parameters" style="border-color: #CCCCCC;" | ||
|- | |- | ||
!width="15%" style="text-align:center;font-weight:bolder;border:1px solid #cccccc"|参数 | !width="15%" style="text-align:center;font-weight:bolder;border:1px solid #cccccc"|参数 | ||
− | !width=" | + | \!width="35%" style="text-align:center;font-weight:bolder;border:1px solid #cccccc"|说明 |
− | + | {{api_args|ToUserName|群发发起人的uid}} | |
− | + | {{api_args|FromUserName|为空}} | |
− | {{api_args| | + | {{api_args|CreateTime|创建时间t}} |
− | {{api_args| | + | {{api_args|MsgType|Event}} |
+ | {{api_args|Event|事件信息,此处为MASSSENDJOBFINISH}} | ||
+ | {{api_args|MsgID|群发的消息ID}} | ||
+ | {{api_args|Status|群发的结构,为“send success”或“send fail”。但send success时,也有可能因用户拒收公众号的消息、系统错误等原因造成少量用户接收失败}} | ||
+ | {{api_args|TotalCount|group_id下粉丝数;或者uid_list中的粉丝数}} | ||
+ | {{api_args|FilterCount|过滤(过滤是指特定地区、性别的过滤、用户设置拒收的过滤,用户接收已超规定条数的过滤)后,准备发送的粉丝数,原则上,FilterCount = SentCount + ErrorCount}} | ||
+ | {{api_args|SentCount|发送成功的粉丝数}} | ||
+ | {{api_args|ErrorCount|发送失败的粉丝数}} | ||
|} | |} |
2014年5月15日 (四) 22:27的版本
目录 |
根据分组进行群发
接口调用请求说明: URL:https://m.api.weibo.com/2/messages/sendall?access_token=ACCESS_TOKEN HTTP 请求方式:POST 授权限制:频次限制是
POST数据说明: 图文素材
{ "filter":{ "group_id":"123" //分组id }, "news":{ "media_id":"XXXXXXXXXX" //通过上传图文消息素材生成的短链 }, "msgtype":"news" }
文本
{ "filter":{ "group_id":"123" //分组id }, "text":{ "content":"CONTENT" //文本内容 }, "msgtype":"text" }
语音
{ "filter":{ "group_id":"123" //分组id }, "voice":{ "media_id":"xxxxxxxxx" //语音id,通过上传下载多媒体文件来得到 }, "msgtype":"voice" }
图片
{ "filter":{ "group_id":"123" //分组id }, "image":{ "media_id":"xxxxxxxxx" //图片id,通过上传下载多媒体文件来得到 }, "msgtype":"image" }
图文消息
{ "filter":{ "group_id":"123" //分组id }, "articles": [ { "display_name": "两个故事", "summary": "今天讲两个故事,分享给你。谁是公司?谁又是中国人?", "image": "http://storage.mcp.weibo.cn/0JlIv.jpg", "url": "http://e.weibo.com/mediaprofile/article/detail?uid=1722052204&aid=983319" }, ... //最多支持8个图文,建议为1或3个 ], "msgtype":"articles" }
//返回说明 调用成功时的返回值:
{ "result": true, "msg_id": xxxxx //成功返回true,消息ID }
调用失败时的返回值:
{ "request": "https://m.api.weibo.com/2/messages/sendall", "errcode": "1000XX", "errmsg": "error message." }
请注意:在返回成功时,意味着群发任务提交成功,并不意味着此时群发已经结束,所以,仍有可能在后续的发送过程中出现异常情况导致用户未收到消息,如消息有时会进行审核、服务器不稳定等。此外,群发任务一般需要较长的时间才能全部发送完毕,请耐心等待。
根据OpenID列表群发
接口调用请求说明: URL:https://m.api.weibo.com/2/messages/sendall?access_token=ACCESS_TOKEN HTTP 请求方式:POST
POST数据说明:
图文素材
{ "touser":[ "uid1", "uid2" ], "news":{ "media_id":"XXXXXXXXXX" //通过上传图文消息素材生成的短链 }, "msgtype":"news" }
文本
{ "touser":[ "uid1", "uid2" ], "text":{ "content":"CONTENT" //文本内容 }, "msgtype":"text" }
语音
{ "touser":[ "uid1", "uid2" ], "voice":{ "media_id":"xxxxxxxxx" //语音id,通过上传下载多媒体文件来得到 }, "msgtype":"voice" }
图片
{ "touser":[ "uid1", "uid2" ], "image":{ "media_id":"xxxxxxxxx" //图片id,通过上传下载多媒体文件来得到 }, "msgtype":"image" }
图文消息
{ "touser":[ "uid1", "uid2" ], "articles": [ { "display_name": "两个故事", "summary": "今天讲两个故事,分享给你。谁是公司?谁又是中国人?", "image": "http://storage.mcp.weibo.cn/0JlIv.jpg", "url": "http://e.weibo.com/mediaprofile/article/detail?uid=1722052204&aid=983319" }, ... //最多支持8个图文,建议为1或3个 ], "msgtype":"articles" }
//返回说明 调用成功时的返回值:
{ "result": true, "msg_id": xxxxx //成功返回true,消息ID }
调用失败时的返回值:
{ "request": "https://m.api.weibo.com/2/messages/sendall", "errcode": "1000XX", "errmsg": "error message." }
请注意:在返回成功时,意味着群发任务提交成功,并不意味着此时群发已经结束,所以,仍有可能在后续的发送过程中出现异常情况导致用户未收到消息,如消息有时会进行审核、服务器不稳定等。此外,群发任务一般需要较长的时间才能全部发送完毕,请耐心等待。
删除群发
接口调用请求说明: URL:https://m.api.weibo.com/2/messages/delete?access_token=ACCESS_TOKEN HTTP 请求方式:POST 授权限制:频次限制是
POST数据说明:
{ "msgid":12333 }
请注意,只有已经发送成功的消息才能删除删除消息只是将消息的图文详情页失效,已经收到的用户,还是能在其本地看到消息卡片。 另外,删除群发消息只能删除news和image,其他类型的消息一经发送,无法删除。
//返回说明
调用成功时的返回值:
{ "result": true }
调用失败时的返回值:
{ "request": "https://m.api.weibo.com/2/messages/delete", "errcode": "1000XX", "errmsg": "error message." }
事情推送群发结果
由于群发任务提交后,群发任务可能在一定时间后才完成,因此,群发接口调用时,仅会给出群发任务是否提交成功的提示,若群发任务提交成功,则在群发任务结束时,会向开发者在粉丝服务平台填写的开发者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>
参数
\!width="35%" style="text-align:center;font-weight:bolder;border:1px solid #cccccc"|说明 | |||
---|---|---|---|
ToUserName | 群发发起人的uid | {{{3}}} | {{{4}}} |
FromUserName | 为空 | {{{3}}} | {{{4}}} |
CreateTime | 创建时间t | {{{3}}} | {{{4}}} |
MsgType | Event | {{{3}}} | {{{4}}} |
Event | 事件信息,此处为MASSSENDJOBFINISH | {{{3}}} | {{{4}}} |
MsgID | 群发的消息ID | {{{3}}} | {{{4}}} |
Status | 群发的结构,为“send success”或“send fail”。但send success时,也有可能因用户拒收公众号的消息、系统错误等原因造成少量用户接收失败 | {{{3}}} | {{{4}}} |
TotalCount | group_id下粉丝数;或者uid_list中的粉丝数 | {{{3}}} | {{{4}}} |
FilterCount | {{{2}}} | {{{3}}} | {{{4}}} |
SentCount | 发送成功的粉丝数 | {{{3}}} | {{{4}}} |
ErrorCount | 发送失败的粉丝数 | {{{3}}} | {{{4}}} |