Package com.foxinmy.weixin4j.mp.api

Class MassApi

  • public class MassApi
extends MpApi
    群发相关API
    Since:
    JDK 1.6
    Author:
    jinyu(foxinmy@gmail.com)

    • Field Summary

      • Fields inherited from class com.foxinmy.weixin4j.api.BaseApi

        weixinExecutor

    • Constructor Summary

      Constructors 
      Constructor Description
      MassApi​(com.foxinmy.weixin4j.token.TokenManager tokenManager)  

    • Constructor Detail

      • MassApi

        public MassApi​(com.foxinmy.weixin4j.token.TokenManager tokenManager)

    • Method Detail

      • uploadArticle

        public String uploadArticle​(List<com.foxinmy.weixin4j.tuple.MpArticle> articles)
                     throws com.foxinmy.weixin4j.exception.WeixinException
        上传图文消息,一个图文消息支持1到10条图文
        具备微信支付权限的公众号，在使用高级群发接口上传、群发图文消息类型时，可使用<a>\u6807\u7b7e\u52a0\u5165\u5916\u94fe
        Parameters:
        articles - 图片消息
        Returns:
        媒体ID
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        上传图文素材, MpArticle

      • massByGroupId

        @Deprecated
public String[] massByGroupId​(com.foxinmy.weixin4j.tuple.MassTuple tuple,
                              boolean isToAll,
                              int groupId)
                       throws com.foxinmy.weixin4j.exception.WeixinException
        Deprecated.
        分组群发

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

        Parameters:
        tuple - 消息元件
        isToAll - 用于设定是否向全部用户发送，值为true或false，选择true该消息群发给所有用户， 选择false可根据group_id发送给指定群组的用户
        groupId - 分组ID
        Returns:
        第一个元素为消息发送任务的ID,第二个元素为消息的数据ID，该字段只有在群发图文消息时，才会出现,可以用于在图文分析数据接口中
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        Group, Text, Image, Voice, MpVideo, MpNews, Card, MassTuple, 根据分组群发

      • massArticleByGroupId

        @Deprecated
public String[] massArticleByGroupId​(List<com.foxinmy.weixin4j.tuple.MpArticle> articles,
                                     int groupId)
                              throws com.foxinmy.weixin4j.exception.WeixinException
        Deprecated.
        分组ID群发图文消息
        Parameters:
        articles - 图文列表
        groupId - 分组ID
        Returns:
        第一个元素为消息发送任务的ID,第二个元素为消息的数据ID，该字段只有在群发图文消息时，才会出现。
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        根据分组群发, MpArticle

      • massToAll

        public String[] massToAll​(com.foxinmy.weixin4j.tuple.MassTuple tuple)
                   throws com.foxinmy.weixin4j.exception.WeixinException
        群发消息给所有粉丝
        Parameters:
        tuple - 消息元件
        Returns:
        第一个元素为消息发送任务的ID,第二个元素为消息的数据ID，该字段只有在群发图文消息时，才会出现,可以用于在图文分析数据接口中
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        根据标签群发

      • massByTagId

        public String[] massByTagId​(com.foxinmy.weixin4j.tuple.MassTuple tuple,
                            int tagId)
                     throws com.foxinmy.weixin4j.exception.WeixinException
        标签群发消息
        Parameters:
        tuple - 消息元件
        tagId - 标签ID
        Returns:
        第一个元素为消息发送任务的ID,第二个元素为消息的数据ID，该字段只有在群发图文消息时，才会出现,可以用于在图文分析数据接口中
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        Tag, #mass(MassTuple, JSONObject, boolean), 根据标签群发

      • massArticleByTagId

        public String[] massArticleByTagId​(List<com.foxinmy.weixin4j.tuple.MpArticle> articles,
                                   int tagId,
                                   boolean ignoreReprint)
                            throws com.foxinmy.weixin4j.exception.WeixinException
        标签群发图文消息
        Parameters:
        articles - 图文列表
        tagId - 标签ID
        ignoreReprint - 图文消息被判定为转载时，是否继续群发
        Returns:
        第一个元素为消息发送任务的ID,第二个元素为消息的数据ID，该字段只有在群发图文消息时，才会出现。
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        根据标签群发, MpArticle

      • massByOpenIds

        public String[] massByOpenIds​(com.foxinmy.weixin4j.tuple.MassTuple tuple,
                              String... openIds)
                       throws com.foxinmy.weixin4j.exception.WeixinException
        openId群发消息
        Parameters:
        tuple - 消息元件
        openIds - openId列表
        Returns:
        第一个元素为消息发送任务的ID,第二个元素为消息的数据ID，该字段只有在群发图文消息时，才会出现,可以用于在图文分析数据接口中
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        根据openid群发, #mass(MassTuple, JSONObject, boolean)

      • massArticleByOpenIds

        public String[] massArticleByOpenIds​(List<com.foxinmy.weixin4j.tuple.MpArticle> articles,
                                     boolean ignoreReprint,
                                     String... openIds)
                              throws com.foxinmy.weixin4j.exception.WeixinException
        openid群发图文消息
        Parameters:
        articles - 图文列表
        ignoreReprint - 图文消息被判定为转载时，是否继续群发
        openIds - openId列表
        Returns:
        第一个元素为消息发送任务的ID,第二个元素为消息的数据ID，该字段只有在群发图文消息时，才会出现,可以用于在图文分析数据接口中.
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        根据openid群发, MpArticle

      • deleteMassNews

        public com.foxinmy.weixin4j.http.weixin.ApiResult deleteMassNews​(String msgid)
                                                          throws com.foxinmy.weixin4j.exception.WeixinException
        删除群发消息
        Parameters:
        msgid - 发送出去的消息ID
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        删除群发, deleteMassNews(String, int)

      • deleteMassNews

        public com.foxinmy.weixin4j.http.weixin.ApiResult deleteMassNews​(String msgid,
                                                                 int articleIndex)
                                                          throws com.foxinmy.weixin4j.exception.WeixinException
        删除群发消息

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

        Parameters:
        msgid - 发送出去的消息ID
        articleIndex - 要删除的文章在图文消息中的位置，第一篇编号为1，该字段不填或填0会删除全部文章
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        删除群发

      • previewMassNews

        public com.foxinmy.weixin4j.http.weixin.ApiResult previewMassNews​(String toUser,
                                                                  String toWxName,
                                                                  com.foxinmy.weixin4j.tuple.MassTuple tuple)
                                                           throws com.foxinmy.weixin4j.exception.WeixinException
        预览群发消息
        开发者可通过该接口发送消息给指定用户，在手机端查看消息的样式和排版
        Parameters:
        toUser - 接收用户的openID
        toWxName - 接收用户的微信号 towxname和touser同时赋值时，以towxname优先
        tuple - 消息元件
        Returns:
        处理结果
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        MassTuple, 预览群发消息

      • getMassNewStatus

        public String getMassNewStatus​(String msgId)
                        throws com.foxinmy.weixin4j.exception.WeixinException
        查询群发发送状态
        Parameters:
        msgId - 消息ID
        Returns:
        消息发送状态,如sendsuccess:发送成功、sendfail:发送失败
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        查询群发状态