com.foxinmy.weixin4j.mp.api
Class MassApi

java.lang.Object
  com.foxinmy.weixin4j.api.BaseApi
      com.foxinmy.weixin4j.mp.api.MpApi
          com.foxinmy.weixin4j.mp.api.MassApi

public class MassApi
extends MpApi

群发相关API

Since:

JDK 1.6

Author:

jinyu(foxinmy@gmail.com)

Constructor Summary

MassApi(TokenManager tokenManager)

Method Summary

ApiResult	deleteMassNews(String msgid) 删除群发消息
String	getMassNewStatus(String msgId) 查询群发发送状态
String[]	massArticleByGroupId(List<MpArticle> articles, int groupId) Deprecated.
String[]	massArticleByOpenIds(List<MpArticle> articles, String... openIds) 根据openid群发图文消息
String[]	massArticleByTagId(List<MpArticle> articles, int tagId) 标签群发图文消息
String[]	massByGroupId(MassTuple tuple, boolean isToAll, int groupId) Deprecated.
String[]	massByOpenIds(MassTuple tuple, String... openIds) openId群发
String[]	massByTagId(MassTuple tuple, boolean isToAll, int tagId) 标签群发
ApiResult	previewMassNews(String toUser, String toWxName, MassTuple tuple) 预览群发消息 开发者可通过该接口发送消息给指定用户，在手机端查看消息的样式和排版
String	uploadArticle(List<MpArticle> articles) 上传图文消息,一个图文消息支持1到10条图文 具备微信支付权限的公众号，在使用高级群发接口上传、群发图文消息类型时，可使用<a>标签加入外链

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MassApi

public MassApi(TokenManager tokenManager)

Method Detail

uploadArticle

public String uploadArticle(List<MpArticle> articles)
                     throws WeixinException

上传图文消息,一个图文消息支持1到10条图文
具备微信支付权限的公众号，在使用高级群发接口上传、群发图文消息类型时，可使用<a>标签加入外链

Parameters:

articles - 图片消息

Returns:

媒体ID

Throws:

WeixinException

See Also:

上传图文素材, MpArticle

massByGroupId

@Deprecated
public String[] massByGroupId(MassTuple tuple,
                                         boolean isToAll,
                                         int groupId)
                       throws WeixinException

Deprecated.

分组群发

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

Parameters:

tuple - 消息元件

isToAll - 用于设定是否向全部用户发送，值为true或false，选择true该消息群发给所有用户， 选择false可根据group_id发送给指定群组的用户

groupId - 分组ID

Returns:

第一个元素为消息发送任务的ID,第二个元素为消息的数据ID，该字段只有在群发图文消息时，才会出现,可以用于在图文分析数据接口中

Throws:

WeixinException

See Also:

Group, Text, Image, Voice, MpVideo, MpNews, Card, MassTuple, GroupApi#getGroups()}, 根据分组群发

massArticleByGroupId

@Deprecated
public String[] massArticleByGroupId(List<MpArticle> articles,
                                                int groupId)
                              throws WeixinException

Deprecated.

分组ID群发图文消息

Parameters:

articles - 图文列表

groupId - 分组ID

Returns:

第一个元素为消息发送任务的ID,第二个元素为消息的数据ID，该字段只有在群发图文消息时，才会出现。

Throws:

WeixinException

See Also:

根据分组群发, #massByGroupId(Tuple,int)}, MpArticle

massByTagId

public String[] massByTagId(MassTuple tuple,
                            boolean isToAll,
                            int tagId)
                     throws WeixinException

标签群发

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

Parameters:

tuple - 消息元件

isToAll - 用于设定是否向全部用户发送，值为true或false，选择true该消息群发给所有用户， 选择false可根据group_id发送给指定群组的用户

tagId - 标签ID

Returns:

第一个元素为消息发送任务的ID,第二个元素为消息的数据ID，该字段只有在群发图文消息时，才会出现,可以用于在图文分析数据接口中

Throws:

WeixinException

See Also:

Tag, Text, Image, Voice, MpVideo, MpNews, Card, MassTuple, TagApi#listTags()}, 根据标签群发

massArticleByTagId

public String[] massArticleByTagId(List<MpArticle> articles,
                                   int tagId)
                            throws WeixinException

标签群发图文消息

Parameters:

articles - 图文列表

tagId - 标签ID

Returns:

第一个元素为消息发送任务的ID,第二个元素为消息的数据ID，该字段只有在群发图文消息时，才会出现。

Throws:

WeixinException

See Also:

根据标签群发, #massByTagId(Tuple,int)}, MpArticle

massByOpenIds

public String[] massByOpenIds(MassTuple tuple,
                              String... openIds)
                       throws WeixinException

openId群发

Parameters:

tuple - 消息元件

openIds - openId列表

Returns:

第一个元素为消息发送任务的ID,第二个元素为消息的数据ID，该字段只有在群发图文消息时，才会出现,可以用于在图文分析数据接口中

Throws:

WeixinException

See Also:

User, Text, Image, Voice, MpVideo, MpNews, Card, MassTuple, 根据openid群发, UserApi#getUser(String)}

massArticleByOpenIds

public String[] massArticleByOpenIds(List<MpArticle> articles,
                                     String... openIds)
                              throws WeixinException

根据openid群发图文消息

Parameters:

articles - 图文列表

openIds - openId列表

Returns:

第一个元素为消息发送任务的ID,第二个元素为消息的数据ID，该字段只有在群发图文消息时，才会出现,可以用于在图文分析数据接口中.

Throws:

WeixinException

See Also:

根据openid群发, #massByOpenIds(Tuple,String...)}, MpArticle

deleteMassNews

public ApiResult deleteMassNews(String msgid)
                         throws WeixinException

删除群发消息

请注意,只有已经发送成功的消息才能删除删除消息只是将消息的图文详情页失效,已经收到的用户,还是能在其本地看到消息卡片

Parameters:

msgid - 发送出去的消息ID

Throws:

WeixinException

See Also:

删除群发, #massByTagId(Tuple, int)}, #massByOpenIds(Tuple, String...)

previewMassNews

public ApiResult previewMassNews(String toUser,
                                 String toWxName,
                                 MassTuple tuple)
                          throws WeixinException

预览群发消息
开发者可通过该接口发送消息给指定用户，在手机端查看消息的样式和排版

Parameters:

toUser - 接收用户的openID

toWxName - 接收用户的微信号 towxname和touser同时赋值时，以towxname优先

tuple - 消息元件

Returns:

处理结果

Throws:

WeixinException

See Also:

MassTuple, 预览群发消息

getMassNewStatus

public String getMassNewStatus(String msgId)
                        throws WeixinException

查询群发发送状态

Parameters:

msgId - 消息ID

Returns:

消息发送状态,如sendsuccess:发送成功、sendfail:发送失败

Throws:

WeixinException

See Also:

查询群发状态