Skip to content

Commit

Permalink
🎨 #2632【企业微信】完善模板卡片消息接口部分参数
Browse files Browse the repository at this point in the history
  • Loading branch information
@xiaohe-53
xiaohe-53 authored May 5, 2022
1 parent 303a0ea commit 946f693
Show file tree
Hide file tree
Showing 9 changed files with 182 additions and 9 deletions.
7 changes: 6 additions & 1 deletion pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,11 @@
<email>huangxm129@163.com</email>
<url>https://github.com/huangxm129</url>
</developer>
<developer>
<name>xiaohe</name>
<email>xiaohe@53jy.net</email>
<url>https://github.com/xiaohe-53</url>
</developer>
</developers>

<scm>
Expand Down Expand Up @@ -302,7 +307,7 @@
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.8</version>
<version>1.18.24</version>
<scope>provided</scope>
</dependency>
<dependency>
Expand Down
22 changes: 20 additions & 2 deletions weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpTaskCardService.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
* <pre>
* 任务卡片管理接口.
* Created by Jeff on 2019-05-16.
* Updted by HeXiao on 2022-03-09.
* </pre>
*
* @author <a href="https://github.com/domainname">Jeff</a>
Expand All @@ -23,9 +24,26 @@ public interface WxCpTaskCardService {
* 注意: 这个方法使用WxCpConfigStorage里的agentId
* </pre>
*
* @param userIds 企业的成员ID列表
* @param taskId 任务卡片ID
* @param userIds 企业的成员ID列表
* @param taskId 任务卡片ID
* @param replaceName 替换文案
*/
void update(List<String> userIds, String taskId, String replaceName) throws WxErrorException;


/**
* 更新按钮为不可点击状态
* 详情请见https://developer.work.weixin.qq.com/document/path/94888#%E6%9B%B4%E6%96%B0%E6%8C%89%E9%92%AE%E4%B8%BA%E4%B8%8D%E5%8F%AF%E7%82%B9%E5%87%BB%E7%8A%B6%E6%80%81
* @param userIds 企业的成员ID列表
* @param partyIds 企业的部门ID列表
* @param tagIds 企业的标签ID列表
* @param atAll 更新整个任务接收人员
* @param responseCode 更新卡片所需要消费的code，可通过发消息接口和回调接口返回值获取，一个code只能调用一次该接口，且只能在24小时内调用
* @param replaceName 需要更新的按钮的文案
* @throws WxErrorException
*/
void updateTemplateCardButton(List<String> userIds, List<Integer> partyIds,
List<Integer> tagIds, Integer atAll, String responseCode,
String replaceName) throws WxErrorException;

}
21 changes: 21 additions & 0 deletions weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpTaskCardServiceImpl.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,25 @@ public void update(List<String> userIds, String taskId, String replaceName) thro
String url = this.mainService.getWxCpConfigStorage().getApiUrl(UPDATE_TASK_CARD);
this.mainService.post(url, WxGsonBuilder.create().toJson(data));
}

@Override
public void updateTemplateCardButton(List<String> userIds, List<Integer> partyIds,
List<Integer> tagIds, Integer atAll,
String responseCode, String replaceName) throws WxErrorException {
Integer agentId = this.mainService.getWxCpConfigStorage().getAgentId();
Map<String, Object> data = new HashMap<>(7);
data.put("userids", userIds);
data.put("partyids", partyIds);
data.put("tagids", tagIds);
data.put("atall", atAll);
data.put("agentid", agentId);
data.put("response_code", responseCode);
Map<String, String> btnMap = new HashMap<>();
btnMap.put("replace_name", replaceName);
data.put("button", btnMap);

String url = this.mainService.getWxCpConfigStorage().getApiUrl(UPDATE_TEMPLATE_CARD);
this.mainService.post(url, WxGsonBuilder.create().toJson(data));

}
}
28 changes: 28 additions & 0 deletions weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/message/WxCpMessage.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,21 @@ public class WxCpMessage implements Serializable {
*/
private String sourceDesc;

/**
* 来源文字的颜色，目前支持：0(默认) 灰色，1 黑色，2 红色，3 绿色
*/
private Integer sourceDescColor;

/**
* 更多操作界面的描述
*/
private String actionMenuDesc;

/**
* 操作列表，列表长度取值范围为 [1, 3]
*/
private List<ActionMenuItem> actionMenuActionList;

/**
* 一级标题，建议不超过36个字
*/
Expand Down Expand Up @@ -482,9 +497,22 @@ private void handleMsgType(JsonObject messageJson) {
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<ActionMenuItem> 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())) {
Expand Down
33 changes: 33 additions & 0 deletions ...n-java-cp/src/main/java/me/chanjar/weixin/cp/bean/messagebuilder/TemplateCardBuilder.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,21 @@ public class TemplateCardBuilder extends BaseBuilder<TemplateCardBuilder> {
*/
private String sourceDesc;

/**
* 来源文字的颜色，目前支持：0(默认) 灰色，1 黑色，2 红色，3 绿色
*/
private Integer sourceDescColor;

/**
* 更多操作界面的描述
*/
private String actionMenuDesc;

/**
* 操作列表，列表长度取值范围为 [1, 3]
*/
private List<ActionMenuItem> actionMenuActionList;

/**
* 一级标题，建议不超过36个字
*/
Expand Down Expand Up @@ -172,6 +187,16 @@ public TemplateCardBuilder cardImageAspectRatio(Float cardImageAspectRatio) {
return this;
}

public TemplateCardBuilder actionMenuDesc(String actionMenuDesc) {
this.actionMenuDesc = actionMenuDesc;
return this;
}

public TemplateCardBuilder actionMenuActionList(List<ActionMenuItem> actionMenuItemList) {
this.actionMenuActionList = actionMenuItemList;
return this;
}

public TemplateCardBuilder sourceIconUrl(String sourceIconUrl) {
this.sourceIconUrl = sourceIconUrl;
return this;
Expand All @@ -182,6 +207,11 @@ public TemplateCardBuilder sourceDesc(String sourceDesc) {
return this;
}

public TemplateCardBuilder sourceDescColor(Integer sourceDescColor) {
this.sourceDescColor = sourceDescColor;
return this;
}

public TemplateCardBuilder mainTitleTitle(String mainTitleTitle) {
this.mainTitleTitle = mainTitleTitle;
return this;
Expand Down Expand Up @@ -294,6 +324,9 @@ public WxCpMessage build() {
m.setCardType(this.cardType);
m.setSourceIconUrl(this.sourceIconUrl);
m.setSourceDesc(this.sourceDesc);
m.setSourceDescColor(this.sourceDescColor);
m.setActionMenuDesc(this.actionMenuDesc);
m.setActionMenuActionList(this.actionMenuActionList);
m.setMainTitleTitle(this.mainTitleTitle);
m.setMainTitleDesc(this.mainTitleDesc);
m.setCardImageUrl(this.cardImageUrl);
Expand Down
40 changes: 40 additions & 0 deletions weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/templatecard/ActionMenuItem.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
package me.chanjar.weixin.cp.bean.templatecard;

import com.google.gson.JsonObject;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;

/**
* 卡片右上角更多操作按钮点击后出现的操作列表，列表长度取值范围为 [1, 3]
* @author xiaohe
* @date 2022-03-06
*/
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class ActionMenuItem implements Serializable {
private static final long serialVersionUID = 400885585614100693L;

/**
* 操作的描述文案
*/
private String text;

/**
* 按钮key值，用户点击后，会产生回调事件将本参数作为EventKey返回，回调事件会带上该key值，最长支持1024字节，不可重复
*/
private String key;

public JsonObject toJson() {
JsonObject btnObject = new JsonObject();
btnObject.addProperty("text", this.getText());
btnObject.addProperty("key", this.getKey());
return btnObject;
}

}
8 changes: 8 additions & 0 deletions weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/templatecard/HorizontalContent.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@ public class HorizontalContent implements Serializable {
*/
private String media_id;

/**
* 成员详情的userid，horizontal_content_list.type是3时必填
*/
private String userid;

public JsonObject toJson() {
JsonObject hContentJson = new JsonObject();

Expand All @@ -61,6 +66,9 @@ public JsonObject toJson() {
if (StringUtils.isNotBlank(this.getMedia_id())) {
hContentJson.addProperty("media_id", this.getMedia_id());
}
if (StringUtils.isNotBlank(this.getUserid())) {
hContentJson.addProperty("userid", this.getUserid());
}
return hContentJson;
}

Expand Down
1 change: 1 addition & 0 deletions weixin-java-cp/src/main/java/me/chanjar/weixin/cp/constant/WxCpApiPathConsts.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@ interface Tag {

interface TaskCard {
String UPDATE_TASK_CARD = "/cgi-bin/message/update_taskcard";
String UPDATE_TEMPLATE_CARD = "/cgi-bin/message/update_template_card";
}

interface Tp {
Expand Down
31 changes: 25 additions & 6 deletions weixin-java-cp/src/test/java/me/chanjar/weixin/cp/bean/message/WxCpMessageTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,12 @@ public void TestTemplateCardBuilder_text_notice() {
.value("企业微信.apk")
.media_id("文件的media_id")
.build();
HorizontalContent hContent4 = HorizontalContent.builder()
.type(3)
.keyname("员工信息")
.value("点击查看")
.userid("zhangsan")
.build();

TemplateCardJump jump1 = TemplateCardJump.builder()
.type(1)
Expand All @@ -178,25 +184,39 @@ public void TestTemplateCardBuilder_text_notice() {
.appid("小程序的appid")
.pagepath("/index.html")
.build();
QuoteArea quoteArea=QuoteArea.builder()
QuoteArea quoteArea = QuoteArea.builder()
.type(1)
.title("引用文献标题")
.appid("小程序的appid")
.pagepath("/index.html")
.url("https://work.weixin.qq.com")
.quoteText("引用文献样式的引用文案")
.build();
ActionMenuItem action1 = ActionMenuItem.builder()
.text("接受推送")
.key("A")
.build();
ActionMenuItem action2 = ActionMenuItem.builder()
.text("不再推送")
.key("B")
.build();
WxCpMessage reply = WxCpMessage.TEMPLATECARD().toUser("OPENID")
.toParty("PartyID1 | PartyID2")
.toTag("TagID1 | TagID2")
.agentId(1000002)
.cardType(WxConsts.TemplateCardType.TEXT_NOTICE)
.taskId("task_id")
.sourceIconUrl("图片的url")
.sourceDesc("企业微信")
.sourceDescColor(1)
.actionMenuDesc("卡片副交互辅助文本说明")
.actionMenuActionList(Arrays.asList(action1, action2))
.mainTitleTitle("欢迎使用企业微信")
.mainTitleDesc("您的好友正在邀请您加入企业微信")
.emphasisContentTitle("100")
.emphasisContentDesc("核心数据")
.subTitleText("下载企业微信还能抢红包！")
.horizontalContents(Arrays.asList(hContent1,hContent2,hContent3))
.horizontalContents(Arrays.asList(hContent1, hContent2, hContent3, hContent4))
.jumps(Arrays.asList(jump1,jump2))
.cardActionType(2)
.cardActionAppid("小程序的appid")
Expand All @@ -209,8 +229,7 @@ public void TestTemplateCardBuilder_text_notice() {
reply.setDuplicateCheckInterval(1800);
// System.out.println(reply.toJson());
assertThat(reply.toJson())
.isEqualTo("{\"agentid\":1000002,\"touser\":\"OPENID\",\"msgtype\":\"template_card\",\"duplicate_check_interval\":1800,\"template_card\":{\"card_type\":\"text_notice\",\"source\":{\"icon_url\":\"图片的url\",\"desc\":\"企业微信\"},\"main_title\":{\"title\":\"欢迎使用企业微信\",\"desc\":\"您的好友正在邀请您加入企业微信\"},\"emphasis_content\":{\"title\":\"100\",\"desc\":\"核心数据\"},\"sub_title_text\":\"下载企业微信还能抢红包！\",\"horizontal_content_list\":[{\"keyname\":\"邀请人\",\"value\":\"张三\"},{\"type\":1,\"keyname\":\"企业微信官网\",\"value\":\"点击访问\",\"url\":\"https://work.weixin.qq.com\"},{\"type\":2,\"keyname\":\"企业微信下载\",\"value\":\"企业微信.apk\",\"media_id\":\"文件的media_id\"}],\"jump_list\":[{\"type\":1,\"title\":\"企业微信官网\",\"url\":\"https://work.weixin.qq.com\"},{\"type\":2,\"title\":\"跳转小程序\",\"appid\":\"小程序的appid\",\"pagepath\":\"/index.html\"}],\"card_action\":{\"type\":2,\"url\":\"https://work.weixin.qq.com\",\"appid\":\"小程序的appid\",\"pagepath\":\"/index.html\"},\"quote_area\":{\"type\":1,\"url\":\"https://work.weixin.qq.com\",\"appid\":\"小程序的appid\",\"pagepath\":\"/index.html\",\"title\":\"引用文献标题\",\"quote_text\":\"引用文献样式的引用文案\"}}}");

.isEqualTo("{\"agentid\":1000002,\"touser\":\"OPENID\",\"msgtype\":\"template_card\",\"toparty\":\"PartyID1 | PartyID2\",\"totag\":\"TagID1 | TagID2\",\"duplicate_check_interval\":1800,\"template_card\":{\"card_type\":\"text_notice\",\"source\":{\"icon_url\":\"图片的url\",\"desc\":\"企业微信\",\"desc_color\":1},\"action_menu\":{\"desc\":\"卡片副交互辅助文本说明\",\"action_list\":[{\"text\":\"接受推送\",\"key\":\"A\"},{\"text\":\"不再推送\",\"key\":\"B\"}]},\"main_title\":{\"title\":\"欢迎使用企业微信\",\"desc\":\"您的好友正在邀请您加入企业微信\"},\"emphasis_content\":{\"title\":\"100\",\"desc\":\"核心数据\"},\"sub_title_text\":\"下载企业微信还能抢红包！\",\"task_id\":\"task_id\",\"horizontal_content_list\":[{\"keyname\":\"邀请人\",\"value\":\"张三\"},{\"type\":1,\"keyname\":\"企业微信官网\",\"value\":\"点击访问\",\"url\":\"https://work.weixin.qq.com\"},{\"type\":2,\"keyname\":\"企业微信下载\",\"value\":\"企业微信.apk\",\"media_id\":\"文件的media_id\"},{\"type\":3,\"keyname\":\"员工信息\",\"value\":\"点击查看\",\"userid\":\"zhangsan\"}],\"jump_list\":[{\"type\":1,\"title\":\"企业微信官网\",\"url\":\"https://work.weixin.qq.com\"},{\"type\":2,\"title\":\"跳转小程序\",\"appid\":\"小程序的appid\",\"pagepath\":\"/index.html\"}],\"card_action\":{\"type\":2,\"url\":\"https://work.weixin.qq.com\",\"appid\":\"小程序的appid\",\"pagepath\":\"/index.html\"},\"quote_area\":{\"type\":1,\"url\":\"https://work.weixin.qq.com\",\"appid\":\"小程序的appid\",\"pagepath\":\"/index.html\",\"title\":\"引用文献标题\",\"quote_text\":\"引用文献样式的引用文案\"}}}");
}

/**
Expand Down Expand Up @@ -404,13 +423,13 @@ public void TestTemplateCardBuilder_multiple_interaction() {
.question_key("question_key1")
.title("选择器标签1")
.selected_id("selection_id1")
.options(Arrays.asList(option1,option2))
.options(Arrays.asList(option1, option2))
.build();
MultipleSelect mSelect2 = MultipleSelect.builder()
.question_key("question_key2")
.title("选择器标签2")
.selected_id("selection_id3")
.options(Arrays.asList(option3,option4))
.options(Arrays.asList(option3, option4))
.build();


Expand Down

0 comments on commit 946f693

Please sign in to comment.