Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
me.chanjar.weixin.cp.bean.message.WxCpMessage Maven / Gradle / Ivy
package me.chanjar.weixin.cp.bean.message;
import com.google.gson.JsonArray;
import com.google.gson.JsonObject;
import lombok.Data;
import me.chanjar.weixin.common.api.WxConsts.KefuMsgType;
import me.chanjar.weixin.cp.bean.article.MpnewsArticle;
import me.chanjar.weixin.cp.bean.article.NewArticle;
import me.chanjar.weixin.cp.bean.messagebuilder.*;
import me.chanjar.weixin.cp.bean.taskcard.TaskCardButton;
import me.chanjar.weixin.cp.bean.templatecard.*;
import org.apache.commons.lang3.StringUtils;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import static me.chanjar.weixin.common.api.WxConsts.KefuMsgType.*;
/**
* 消息.
*
* @author Daniel Qian
*/
@Data
public class WxCpMessage implements Serializable {
private static final long serialVersionUID = -2082278303476631708L;
/**
* 指定接收消息的成员，成员ID列表（多个接收者用‘|’分隔，最多支持1000个）。
* 特殊情况：指定为"@all"，则向该企业应用的全部成员发送
*/
private String toUser;
/**
* 指定接收消息的部门，部门ID列表，多个接收者用‘|’分隔，最多支持100个。
* 当touser为"@all"时忽略本参数
*/
private String toParty;
/**
* 指定接收消息的标签，标签ID列表，多个接收者用‘|’分隔，最多支持100个。
* 当touser为"@all"时忽略本参数
*/
private String toTag;
/**
* 企业应用的id，整型。企业内部开发，可在应用的设置页面查看；第三方服务商，可通过接口 获取企业授权信息 获取该参数值
*/
private Integer agentId;
/**
* 消息类型
* 文本消息: text
* 图片消息: image
* 语音消息: voice
* 视频消息: video
* 文件消息: file
* 文本卡片消息: textcard
* 图文消息: news
* 图文消息: mpnews
* markdown消息: markdown
* 模板卡片消息: template_card
*/
private String msgType;
/**
* 消息内容，最长不超过2048个字节，超过将截断（支持id转译）
*/
private String content;
/**
* 媒体文件id，可以调用上传临时素材接口获取
*/
private String mediaId;
/**
* 图文消息缩略图的media_id, 可以通过素材管理接口获得。此处thumb_media_id即上传接口返回的media_id
*/
private String thumbMediaId;
/**
* 标题，不超过128个字节，超过会自动截断（支持id转译）
*/
private String title;
/**
* 描述，不超过512个字节，超过会自动截断（支持id转译）
*/
private String description;
private String musicUrl;
private String hqMusicUrl;
/**
* 表示是否是保密消息，默认为0；注意仅 mpnews 类型的消息支持safe值为2，其他消息类型不支持
* 0表示可对外分享
* 1表示不能分享且内容显示水印
* 2表示仅限在企业内分享
*/
private String safe;
/**
* 点击后跳转的链接。最长2048字节，请确保包含了协议头(http/https)
*/
private String url;
/**
* 按钮文字。 默认为“详情”， 不超过4个文字，超过自动截断。
*/
private String btnTxt;
/**
* 图文消息，一个图文消息支持1到8条图文
*/
private List articles = new ArrayList<>();
/**
* 图文消息，一个图文消息支持1到8条图文
*/
private List mpnewsArticles = new ArrayList<>();
/**
* 小程序appid，必须是与当前应用关联的小程序，appid和pagepath必须同时填写，填写后会忽略url字段
*/
private String appId;
/**
* 点击消息卡片后的小程序页面，最长1024个字节，仅限本小程序内的页面。该字段不填则消息点击后不跳转。
*/
private String page;
/**
* 是否放大第一个content_item
*/
private Boolean emphasisFirstItem;
/**
* 消息内容键值对，最多允许10个item
*/
private Map contentItems;
/**
* enable_id_trans
* 表示是否开启id转译，0表示否，1表示是，默认0
*/
private Boolean enableIdTrans = false;
/**
* enable_duplicate_check
* 表示是否开启重复消息检查，0表示否，1表示是，默认0
*/
private Boolean enableDuplicateCheck = false;
/**
* duplicate_check_interval
* 表示是否重复消息检查的时间间隔，默认1800s，最大不超过4小时
*/
private Integer duplicateCheckInterval;
/**
* 任务卡片特有的属性.
*/
private String taskId;
private List taskButtons = new ArrayList<>();
// 模板型卡片特有属性
/**
* 模板卡片类型，文本通知型卡片填写 “text_notice”,
* 图文展示型卡片此处填写 “news_notice”,
* 按钮交互型卡片填写”button_interaction”,
* 投票选择型卡片填写”vote_interaction”,
* 多项选择型卡片填写 “multiple_interaction”
*/
private String cardType;
/**
* 卡片来源样式信息，不需要来源样式可不填写
* 来源图片的url
*/
private String sourceIconUrl;
/**
* 卡片来源样式信息，不需要来源样式可不填写
* 来源图片的描述，建议不超过20个字
*/
private String sourceDesc;
/**
* 来源文字的颜色，目前支持：0(默认) 灰色，1 黑色，2 红色，3 绿色
*/
private Integer sourceDescColor;
/**
* 更多操作界面的描述
*/
private String actionMenuDesc;
/**
* 操作列表，列表长度取值范围为 [1, 3]
*/
private List actionMenuActionList;
/**
* 一级标题，建议不超过36个字
*/
private String mainTitleTitle;
/**
* 标题辅助信息，建议不超过44个字
*/
private String mainTitleDesc;
/**
* 左图右文样式，news_notice类型的卡片，card_image 和 image_text_area 两者必填一个字段，不可都不填
*/
private TemplateCardImageTextArea imageTextArea;
/**
* 图文展示型的卡片必须有图片字段。
* 图片的url.
*/
private String cardImageUrl;
/**
* 图片的宽高比，宽高比要小于2.25，大于1.3，不填该参数默认1.3
*/
private Float cardImageAspectRatio;
/**
* 关键数据样式
* 关键数据样式的数据内容，建议不超过14个字
*/
private String emphasisContentTitle;
/**
* 关键数据样式的数据描述内容，建议不超过22个字
*/
private String emphasisContentDesc;
/**
* 二级普通文本，建议不超过160个字
*/
private String subTitleText;
/**
* 卡片二级垂直内容，该字段可为空数组，但有数据的话需确认对应字段是否必填，列表长度不超过4
*/
private List verticalContents;
/**
* 二级标题+文本列表，该字段可为空数组，但有数据的话需确认对应字段是否必填，列表长度不超过6
*/
private List horizontalContents;
/**
* 跳转指引样式的列表，该字段可为空数组，但有数据的话需确认对应字段是否必填，列表长度不超过3
*/
private List jumps;
/**
* 整体卡片的点击跳转事件，text_notice必填本字段
* 跳转事件类型，1 代表跳转url，2 代表打开小程序。text_notice卡片模版中该字段取值范围为[1,2]
*/
private Integer cardActionType;
/**
* 跳转事件的url，card_action.type是1时必填
*/
private String cardActionUrl;
/**
* 跳转事件的小程序的appid，必须是与当前应用关联的小程序，card_action.type是2时必填
*/
private String cardActionAppid;
/**
* 跳转事件的小程序的pagepath，card_action.type是2时选填
*/
private String cardActionPagepath;
/**
* 按钮交互型卡片需指定。
* button_selection
*/
private TemplateCardButtonSelection buttonSelection;
/**
* 按钮交互型卡片需指定。
* 按钮列表，该字段可为空数组，但有数据的话需确认对应字段是否必填，列表长度不超过6
*/
private List buttons;
/**
* 投票选择型卡片需要指定
* 选择题key值，用户提交选项后，会产生回调事件，回调事件会带上该key值表示该题，最长支持1024字节
*/
private String checkboxQuestionKey;
/**
* 选择题模式，单选：0，多选：1，不填默认0
*/
private Integer checkboxMode;
/**
* 选项list，选项个数不超过 20 个，最少1个
*/
private List options;
/**
* 提交按钮样式
* 按钮文案，建议不超过10个字，不填默认为提交
*/
private String submitButtonText;
/**
* 提交按钮的key，会产生回调事件将本参数作为EventKey返回，最长支持1024字节
*/
private String submitButtonKey;
/**
* 下拉式的选择器列表，multiple_interaction类型的卡片该字段不可为空，一个消息最多支持 3 个选择器
*/
private List selects;
/**
* 引用文献样式
*/
private QuoteArea quoteArea;
/**
* 获得文本消息builder.
*
* @return the text builder
*/
public static TextBuilder TEXT() {
return new TextBuilder();
}
/**
* 获得文本卡片消息builder.
*
* @return the text card builder
*/
public static TextCardBuilder TEXTCARD() {
return new TextCardBuilder();
}
/**
* 获得图片消息builder.
*
* @return the image builder
*/
public static ImageBuilder IMAGE() {
return new ImageBuilder();
}
/**
* 获得语音消息builder.
*
* @return the voice builder
*/
public static VoiceBuilder VOICE() {
return new VoiceBuilder();
}
/**
* 获得视频消息builder.
*
* @return the video builder
*/
public static VideoBuilder VIDEO() {
return new VideoBuilder();
}
/**
* 获得图文消息builder.
*
* @return the news builder
*/
public static NewsBuilder NEWS() {
return new NewsBuilder();
}
/**
* 获得mpnews图文消息builder.
*
* @return the mpnews builder
*/
public static MpnewsBuilder MPNEWS() {
return new MpnewsBuilder();
}
/**
* 获得markdown消息builder.
*
* @return the markdown msg builder
*/
public static MarkdownMsgBuilder MARKDOWN() {
return new MarkdownMsgBuilder();
}
/**
* 获得文件消息builder.
*
* @return the file builder
*/
public static FileBuilder FILE() {
return new FileBuilder();
}
/**
* 获得任务卡片消息builder.
*
* @return the task card builder
*/
public static TaskCardBuilder TASKCARD() {
return new TaskCardBuilder();
}
/**
* 获得模板卡片消息builder.
*
* @return the template card builder
*/
public static TemplateCardBuilder TEMPLATECARD() {
return new TemplateCardBuilder();
}
/**
* 获得小程序通知消息builder.
*
* @return the mini program notice msg builder
*/
public static MiniProgramNoticeMsgBuilder newMiniProgramNoticeBuilder() {
return new MiniProgramNoticeMsgBuilder();
}
/**
*
* 请使用.
* {@link KefuMsgType#TEXT}
* {@link KefuMsgType#IMAGE}
* {@link KefuMsgType#VOICE}
* {@link KefuMsgType#MUSIC}
* {@link KefuMsgType#VIDEO}
* {@link KefuMsgType#NEWS}
* {@link KefuMsgType#MPNEWS}
* {@link KefuMsgType#MARKDOWN}
* {@link KefuMsgType#TASKCARD}
* {@link KefuMsgType#MINIPROGRAM_NOTICE}
* {@link KefuMsgType#TEMPLATE_CARD}
*
*
* @param msgType 消息类型
*/
public void setMsgType(String msgType) {
this.msgType = msgType;
}
/**
* To json string.
*
* @return the string
*/
public String toJson() {
JsonObject messageJson = new JsonObject();
if (this.getAgentId() != null) {
messageJson.addProperty("agentid", this.getAgentId());
}
if (StringUtils.isNotBlank(this.getToUser())) {
messageJson.addProperty("touser", this.getToUser());
}
messageJson.addProperty("msgtype", this.getMsgType());
if (StringUtils.isNotBlank(this.getToParty())) {
messageJson.addProperty("toparty", this.getToParty());
}
if (StringUtils.isNotBlank(this.getToTag())) {
messageJson.addProperty("totag", this.getToTag());
}
if (this.getEnableIdTrans()) {
messageJson.addProperty("enable_id_trans", 1);
}
if (this.getEnableDuplicateCheck()) {
messageJson.addProperty("enable_duplicate_check", 1);
}
if (this.getDuplicateCheckInterval() != null) {
messageJson.addProperty("duplicate_check_interval", this.getDuplicateCheckInterval());
}
this.handleMsgType(messageJson);
if (StringUtils.isNotBlank(this.getSafe())) {
messageJson.addProperty("safe", this.getSafe());
}
return messageJson.toString();
}
private void handleMsgType(JsonObject messageJson) {
switch (this.getMsgType()) {
case TEXT: {
JsonObject text = new JsonObject();
text.addProperty("content", this.getContent());
messageJson.add("text", text);
break;
}
case MARKDOWN: {
JsonObject text = new JsonObject();
text.addProperty("content", this.getContent());
messageJson.add("markdown", text);
break;
}
case TEXTCARD: {
JsonObject text = new JsonObject();
text.addProperty("title", this.getTitle());
text.addProperty("description", this.getDescription());
text.addProperty("url", this.getUrl());
text.addProperty("btntxt", this.getBtnTxt());
messageJson.add("textcard", text);
break;
}
case IMAGE: {
JsonObject image = new JsonObject();
image.addProperty("media_id", this.getMediaId());
messageJson.add("image", image);
break;
}
case FILE: {
JsonObject image = new JsonObject();
image.addProperty("media_id", this.getMediaId());
messageJson.add("file", image);
break;
}
case VOICE: {
JsonObject voice = new JsonObject();
voice.addProperty("media_id", this.getMediaId());
messageJson.add("voice", voice);
break;
}
case VIDEO: {
JsonObject video = new JsonObject();
video.addProperty("media_id", this.getMediaId());
video.addProperty("thumb_media_id", this.getThumbMediaId());
video.addProperty("title", this.getTitle());
video.addProperty("description", this.getDescription());
messageJson.add("video", video);
break;
}
case NEWS: {
JsonObject newsJsonObject = new JsonObject();
JsonArray articleJsonArray = new JsonArray();
for (NewArticle article : this.getArticles()) {
JsonObject articleJson = new JsonObject();
articleJson.addProperty("title", article.getTitle());
articleJson.addProperty("description", article.getDescription());
articleJson.addProperty("url", article.getUrl());
articleJson.addProperty("picurl", article.getPicUrl());
articleJson.addProperty("appid", article.getAppid());
articleJson.addProperty("pagepath", article.getPagepath());
articleJsonArray.add(articleJson);
}
newsJsonObject.add("articles", articleJsonArray);
messageJson.add("news", newsJsonObject);
break;
}
case MPNEWS: {
JsonObject newsJsonObject = new JsonObject();
if (this.getMediaId() != null) {
newsJsonObject.addProperty("media_id", this.getMediaId());
} else {
JsonArray articleJsonArray = new JsonArray();
for (MpnewsArticle article : this.getMpnewsArticles()) {
article2Json(articleJsonArray, article);
}
newsJsonObject.add("articles", articleJsonArray);
}
messageJson.add("mpnews", newsJsonObject);
break;
}
case TASKCARD: {
JsonObject text = new JsonObject();
text.addProperty("title", this.getTitle());
text.addProperty("description", this.getDescription());
if (StringUtils.isNotBlank(this.getUrl())) {
text.addProperty("url", this.getUrl());
}
text.addProperty("task_id", this.getTaskId());
JsonArray buttonJsonArray = new JsonArray();
for (TaskCardButton button : this.getTaskButtons()) {
btn2Json(buttonJsonArray, button);
}
text.add("btn", buttonJsonArray);
messageJson.add("taskcard", text);
break;
}
case MINIPROGRAM_NOTICE: {
JsonObject notice = new JsonObject();
notice.addProperty("appid", this.getAppId());
notice.addProperty("page", this.getPage());
notice.addProperty("description", this.getDescription());
notice.addProperty("title", this.getTitle());
notice.addProperty("emphasis_first_item", this.getEmphasisFirstItem());
JsonArray content = new JsonArray();
for (Map.Entry item : this.getContentItems().entrySet()) {
JsonObject articleJson = new JsonObject();
articleJson.addProperty("key", item.getKey());
articleJson.addProperty("value", item.getValue());
content.add(articleJson);
}
notice.add("content_item", content);
messageJson.add("miniprogram_notice", notice);
break;
}
case TEMPLATE_CARD: {
JsonObject template = new JsonObject();
template.addProperty("card_type", this.getCardType());
if (StringUtils.isNotBlank(this.getSourceIconUrl()) || StringUtils.isNotBlank(this.getSourceDesc())) {
JsonObject source = new JsonObject();
if (StringUtils.isNotBlank(this.getSourceIconUrl())) {
source.addProperty("icon_url", this.getSourceIconUrl());
}
if (StringUtils.isNotBlank(this.getSourceDesc())) {
source.addProperty("desc", this.getSourceDesc());
}
source.addProperty("desc_color", this.getSourceDescColor());
template.add("source", source);
}
if (StringUtils.isNotBlank(this.getActionMenuDesc())) {
JsonObject action_menu = new JsonObject();
action_menu.addProperty("desc", this.getActionMenuDesc());
JsonArray actionList = new JsonArray();
List actionMenuItemList = this.getActionMenuActionList();
for (ActionMenuItem actionItemI : actionMenuItemList) {
actionList.add(actionItemI.toJson());
}
action_menu.add("action_list", actionList);
template.add("action_menu", action_menu);
}
if (StringUtils.isNotBlank(this.getMainTitleTitle()) || StringUtils.isNotBlank(this.getMainTitleDesc())) {
JsonObject mainTitle = new JsonObject();
if (StringUtils.isNotBlank(this.getMainTitleTitle())) {
mainTitle.addProperty("title", this.getMainTitleTitle());
}
if (StringUtils.isNotBlank(this.getMainTitleDesc())) {
mainTitle.addProperty("desc", this.getMainTitleDesc());
}
template.add("main_title", mainTitle);
}
if (this.getImageTextArea() != null) {
template.add("image_text_area", this.getImageTextArea().toJson());
}
if (StringUtils.isNotBlank(this.getCardImageUrl()) || this.getCardImageAspectRatio() != null) {
JsonObject cardImage = new JsonObject();
if (StringUtils.isNotBlank(this.getCardImageUrl())) {
cardImage.addProperty("url", this.getCardImageUrl());
}
if (null != this.getCardImageAspectRatio()) {
cardImage.addProperty("aspect_ratio", this.getCardImageAspectRatio());
}
template.add("card_image", cardImage);
}
if (StringUtils.isNotBlank(this.getEmphasisContentTitle()) || StringUtils.isNotBlank(this.getEmphasisContentDesc())) {
JsonObject emphasisContent = new JsonObject();
if (StringUtils.isNotBlank(this.getEmphasisContentTitle())) {
emphasisContent.addProperty("title", this.getEmphasisContentTitle());
}
if (StringUtils.isNotBlank(this.getEmphasisContentDesc())) {
emphasisContent.addProperty("desc", this.getEmphasisContentDesc());
}
template.add("emphasis_content", emphasisContent);
}
if (StringUtils.isNotBlank(this.getSubTitleText())) {
template.addProperty("sub_title_text", this.getSubTitleText());
}
if (StringUtils.isNotBlank(this.getTaskId())) {
template.addProperty("task_id", this.getTaskId());
}
List verticalContents = this.getVerticalContents();
if (null != verticalContents && !verticalContents.isEmpty()) {
JsonArray vContentJsonArray = new JsonArray();
for (VerticalContent vContent : this.getVerticalContents()) {
JsonObject tempObject = vContent.toJson();
vContentJsonArray.add(tempObject);
}
template.add("vertical_content_list", vContentJsonArray);
}
List horizontalContents = this.getHorizontalContents();
if (null != horizontalContents && !horizontalContents.isEmpty()) {
JsonArray hContentJsonArray = new JsonArray();
for (HorizontalContent hContent : this.getHorizontalContents()) {
JsonObject tempObject = hContent.toJson();
hContentJsonArray.add(tempObject);
}
template.add("horizontal_content_list", hContentJsonArray);
}
List jumps = this.getJumps();
if (null != jumps && !jumps.isEmpty()) {
JsonArray jumpJsonArray = new JsonArray();
for (TemplateCardJump jump : this.getJumps()) {
JsonObject tempObject = jump.toJson();
jumpJsonArray.add(tempObject);
}
template.add("jump_list", jumpJsonArray);
}
if (null != this.getCardActionType()) {
JsonObject cardAction = new JsonObject();
cardAction.addProperty("type", this.getCardActionType());
if (StringUtils.isNotBlank(this.getCardActionUrl())) {
cardAction.addProperty("url", this.getCardActionUrl());
}
if (StringUtils.isNotBlank(this.getCardActionAppid())) {
cardAction.addProperty("appid", this.getCardActionAppid());
}
if (StringUtils.isNotBlank(this.getCardActionPagepath())) {
cardAction.addProperty("pagepath", this.getCardActionPagepath());
}
template.add("card_action", cardAction);
}
TemplateCardButtonSelection buttonSelection = this.getButtonSelection();
if (null != buttonSelection) {
template.add("button_selection", buttonSelection.toJson());
}
List buttons = this.getButtons();
if (null != buttons && !buttons.isEmpty()) {
JsonArray btnJsonArray = new JsonArray();
for (TemplateCardButton btn : this.getButtons()) {
JsonObject tempObject = btn.toJson();
btnJsonArray.add(tempObject);
}
template.add("button_list", btnJsonArray);
}
// checkbox
if (StringUtils.isNotBlank(this.getCheckboxQuestionKey())) {
JsonObject checkBox = new JsonObject();
checkBox.addProperty("question_key", this.getCheckboxQuestionKey());
if (null != this.getCheckboxMode()) {
checkBox.addProperty("mode", this.getCheckboxMode());
}
JsonArray optionArray = new JsonArray();
for (CheckboxOption option : this.getOptions()) {
JsonObject tempObject = option.toJson();
optionArray.add(tempObject);
}
checkBox.add("option_list", optionArray);
template.add("checkbox", checkBox);
}
// submit_button
if (StringUtils.isNotBlank(this.getSubmitButtonText()) || StringUtils.isNotBlank(this.getSubmitButtonKey())) {
JsonObject submit_button = new JsonObject();
if (StringUtils.isNotBlank(this.getSubmitButtonText())) {
submit_button.addProperty("text", this.getSubmitButtonText());
}
if (StringUtils.isNotBlank(this.getSubmitButtonKey())) {
submit_button.addProperty("key", this.getSubmitButtonKey());
}
template.add("submit_button", submit_button);
}
// select_list
List selects = this.getSelects();
if (null != selects && !selects.isEmpty()) {
JsonArray selectJsonArray = new JsonArray();
for (MultipleSelect select : this.getSelects()) {
JsonObject tempObject = select.toJson();
selectJsonArray.add(tempObject);
}
template.add("select_list", selectJsonArray);
}
QuoteArea quoteArea = this.getQuoteArea();
if (null != quoteArea) {
JsonObject quoteAreaJson = quoteArea.toJson();
template.add("quote_area", quoteAreaJson);
}
messageJson.add("template_card", template);
break;
}
default: {
// do nothing
}
}
}
private void btn2Json(JsonArray buttonJsonArray, TaskCardButton button) {
JsonObject buttonJson = new JsonObject();
buttonJson.addProperty("key", button.getKey());
buttonJson.addProperty("name", button.getName());
if (StringUtils.isNotBlank(button.getReplaceName())) {
buttonJson.addProperty("replace_name", button.getReplaceName());
}
if (StringUtils.isNotBlank(button.getColor())) {
buttonJson.addProperty("color", button.getColor());
}
if (button.getBold() != null) {
buttonJson.addProperty("is_bold", button.getBold());
}
buttonJsonArray.add(buttonJson);
}
private void article2Json(JsonArray articleJsonArray, MpnewsArticle article) {
JsonObject articleJson = new JsonObject();
articleJson.addProperty("title", article.getTitle());
articleJson.addProperty("thumb_media_id", article.getThumbMediaId());
articleJson.addProperty("author", article.getAuthor());
articleJson.addProperty("content_source_url", article.getContentSourceUrl());
articleJson.addProperty("content", article.getContent());
articleJson.addProperty("digest", article.getDigest());
articleJson.addProperty("show_cover_pic", article.getShowCoverPic());
articleJsonArray.add(articleJson);
}
}
