🎨 批量修复部分javadoc里的错误标签或不规范代码

This commit is contained in:
Binary Wang
2026-01-06 16:51:30 +08:00
parent 37c2db9672
commit 51d2ed7a3c
112 changed files with 751 additions and 419 deletions

View File

@@ -9,7 +9,7 @@ import java.util.List;
* 企业互联相关接口
*
* @author libo <422423229@qq.com>
* Created on 27/2/2023 9:57 PM
* @since 2023-02-27 9:57 PM
*/
public interface WxCpCorpGroupService {
/**

View File

@@ -85,7 +85,7 @@ public interface WxCpExportService {
* 获取导出结果
*
* 请求方式GETHTTPS
* 请求地址:<a href="https://qyapi.weixin.qq.com/cgi-bin/export/get_result?access_token=ACCESS_TOKEN&jobid=jobid_xxxxxxxxxxxxxxx">https://qyapi.weixin.qq.com/cgi-bin/export/get_result?access_token=ACCESS_TOKEN&jobid=jobid_xxxxxxxxxxxxxxx</a>
* {@code 请求地址:<a href="https://qyapi.weixin.qq.com/cgi-bin/export/get_result?access_token=ACCESS_TOKEN&jobid=jobid_xxxxxxxxxxxxxxx">https://qyapi.weixin.qq.com/cgi-bin/export/get_result?access_token=ACCESS_TOKEN&jobid=jobid_xxxxxxxxxxxxxxx</a>}
*
* 文档地址:<a href="https://developer.work.weixin.qq.com/document/path/94854">https://developer.work.weixin.qq.com/document/path/94854</a>
* 返回的url文件下载解密可参考 <a href="https://blog.csdn.net/a201692/article/details/123530529">CSDN</a>

View File

@@ -146,7 +146,7 @@ public interface WxCpExternalContactService {
* 企业可通过此接口根据外部联系人的userid如何获取?),拉取客户详情。
*
* 请求方式GETHTTPS
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get?access_token=ACCESS_TOKEN&external_userid=EXTERNAL_USERID
* {@code 请求地址https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get?access_token=ACCESS_TOKEN&external_userid=EXTERNAL_USERID}
*
* 权限说明:
*
@@ -252,9 +252,9 @@ public interface WxCpExternalContactService {
*
* 权限说明:
*
* 该企业授权了该服务商第三方应用,且授权的第三方应用具备“企业客户权限->客户基础信息”权限
* {@code 该企业授权了该服务商第三方应用,且授权的第三方应用具备“企业客户权限->客户基础信息”权限}
* 该客户的跟进人必须在应用的可见范围之内
* 应用需具备“企业客户权限->客户基础信息”权限
* {@code 应用需具备“企业客户权限->客户基础信息”权限}
* </pre>
*
* @param externalUserid 代开发自建应用获取到的外部联系人ID
@@ -276,8 +276,8 @@ public interface WxCpExternalContactService {
*
* @param externalUserid 服务商主体的external_userid必须是source_agentid对应的应用所获取
* @param sourceAgentId 企业授权的代开发自建应用或第三方应用的agentid
* @return
* @throws WxErrorException
* @return 企业的external_userid
* @throws WxErrorException 微信错误异常
*/
String fromServiceExternalUserid(String externalUserid, String sourceAgentId) throws WxErrorException;
@@ -362,7 +362,7 @@ public interface WxCpExternalContactService {
* 权限说明:
*
* 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用accesstoken如何获取
* 第三方应用需具有“企业客户权限->客户基础信息”权限
* {@code 第三方应用需具有“企业客户权限->客户基础信息”权限}
* 对于第三方/自建应用,群主必须在应用的可见范围
* 仅支持企业服务人员创建的客户群
* 仅可转换出自己企业下的客户群chat_id
@@ -410,11 +410,12 @@ public interface WxCpExternalContactService {
* 文档地址: https://developer.work.weixin.qq.com/document/path/99434
* </pre>
*
* 注意企业可通过外部联系人临时ID排除重复数据外部联系人临时ID有效期为4小时。
*
* @param cursor the cursor
* @param limit the limit
* @return 已服务的外部联系人列表
* @throws WxErrorException .
* @apiNote 企业可通过外部联系人临时ID排除重复数据外部联系人临时ID有效期为4小时。
*/
WxCpExternalContactListInfo getContactList(String cursor, Integer limit) throws WxErrorException;
@@ -438,7 +439,7 @@ public interface WxCpExternalContactService {
* 企业可通过此接口获取指定成员添加的客户列表。客户是指配置了客户联系功能的成员所添加的外部联系人。没有配置客户联系功能的成员,所添加的外部联系人将不会作为客户返回。
*
* 请求方式GETHTTPS
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/externalcontact/list?access_token=ACCESS_TOKEN&userid=USERID
* {@code 请求地址https://qyapi.weixin.qq.com/cgi-bin/externalcontact/list?access_token=ACCESS_TOKEN&userid=USERID}
*
* 权限说明:
*
@@ -469,7 +470,8 @@ public interface WxCpExternalContactService {
/**
* 获取待分配的离职成员列表
* 企业和第三方可通过此接口,获取所有离职成员的客户列表,并可进一步调用分配离职成员的客户接口将这些客户重新分配给其他企业成员。
* <p>
*
* 请求方式POSTHTTPS
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_unassigned_list?access_token=ACCESS_TOKEN
*
@@ -496,17 +498,17 @@ public interface WxCpExternalContactService {
/**
* 企业可通过此接口,转接在职成员的客户给其他成员。
* <per>
* <pre>
* external_userid必须是handover_userid的客户即配置了客户联系功能的成员所添加的联系人
* 在职成员的每位客户最多被分配2次。客户被转接成功后将有90个自然日的服务关系保护期保护期内的客户无法再次被分配。
* <p>
*
* 权限说明:
* * 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用accesstoken如何获取
* 第三方应用需拥有“企业客户权限->客户联系->在职继承”权限
* 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用accesstoken如何获取
* {@code 第三方应用需拥有“企业客户权限->客户联系->在职继承”权限}
* 接替成员必须在此第三方应用或自建应用的可见范围内。
* 接替成员需要配置了客户联系功能。
* 接替成员需要在企业微信激活且已经过实名认证。
* </per>
* </pre>
*
* @param req 转接在职成员的客户给其他成员请求实体
* @return wx cp base resp
@@ -516,13 +518,13 @@ public interface WxCpExternalContactService {
/**
* 企业和第三方可通过此接口查询在职成员的客户转接情况。
* <per>
* <pre>
* 权限说明:
* <p>
*
* 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用accesstoken如何获取
* 第三方应用需拥有“企业客户权限->客户联系->在职继承”权限
* {@code 第三方应用需拥有“企业客户权限->客户联系->在职继承”权限}
* 接替成员必须在此第三方应用或自建应用的可见范围内。
* </per>
* </pre>
*
* @param handOverUserid 原添加成员的userid
* @param takeOverUserid 接替成员的userid
@@ -535,19 +537,21 @@ public interface WxCpExternalContactService {
/**
* 企业可通过此接口,分配离职成员的客户给其他成员。
* <per>
* <pre>
* handover_userid必须是已离职用户。
* external_userid必须是handover_userid的客户即配置了客户联系功能的成员所添加的联系人
* 在职成员的每位客户最多被分配2次。客户被转接成功后将有90个自然日的服务关系保护期保护期内的客户无法再次被分配。
* <p>
*
* 权限说明:
* <p>
*
* 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用accesstoken如何获取
* 第三方应用需拥有“企业客户权限->客户联系->离职分配”权限
* {@code 第三方应用需拥有“企业客户权限->客户联系->离职分配”权限}
* 接替成员必须在此第三方应用或自建应用的可见范围内。
* 接替成员需要配置了客户联系功能。
* 接替成员需要在企业微信激活且已经过实名认证。
* </per>
* </pre>
*
* @param req 转接在职成员的客户给其他成员请求实体
* @return wx cp base resp
@@ -557,13 +561,14 @@ public interface WxCpExternalContactService {
/**
* 企业和第三方可通过此接口查询离职成员的客户分配情况。
* <per>
* <pre>
* 权限说明:
* <p>
*
* 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用accesstoken如何获取
* 第三方应用需拥有“企业客户权限->客户联系->在职继承”权限
* {@code 第三方应用需拥有“企业客户权限->客户联系->在职继承”权限}
* 接替成员必须在此第三方应用或自建应用的可见范围内。
* </per>
* </pre>
*
* @param handOverUserid 原添加成员的userid
* @param takeOverUserid 接替成员的userid
@@ -630,21 +635,24 @@ public interface WxCpExternalContactService {
/**
* 企业可通过此接口,将已离职成员为群主的群,分配给另一个客服成员。
*
* <per>
* <pre>
* 注意::
* <p>
*
* 群主离职了的客户群,才可继承
* 继承给的新群主,必须是配置了客户联系功能的成员
* 继承给的新群主,必须有设置实名
* 继承给的新群主,必须有激活企业微信
* 同一个人的群限制每天最多分配300个给新群主
* <p>
*
* 权限说明:
* <p>
*
* 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用accesstoken如何获取
* 第三方应用需拥有“企业客户权限->客户联系->分配离职成员的客户群”权限
* {@code 第三方应用需拥有“企业客户权限->客户联系->分配离职成员的客户群”权限}
* 对于第三方/自建应用,群主必须在应用的可见范围。
* </per>
* </pre>
*
* @param chatIds 需要转群主的客户群ID列表。取值范围 1 ~ 100
* @param newOwner 新群主ID
@@ -656,7 +664,7 @@ public interface WxCpExternalContactService {
/**
* 企业可通过此接口,将在职成员为群主的群,分配给另一个客服成员。
* <per>
* <pre>
* 注意:
* 继承给的新群主,必须是配置了客户联系功能的成员
* 继承给的新群主,必须有设置实名
@@ -716,11 +724,14 @@ public interface WxCpExternalContactService {
* 企业可通过此接口添加企业群发消息的任务并通知客服人员发送给相关客户或客户群。企业微信终端需升级到2.7.5版本及以上)
* 注意:调用该接口并不会直接发送消息给客户/客户群需要相关的客服人员操作以后才会实际发送客服人员的企业微信需要升级到2.7.5及以上版本)
* 同一个企业每个自然月内仅可针对一个客户/客户群发送4条消息超过限制的用户将会被忽略。
* <p>
*
* 请求方式: POST(HTTP)
* <p>
*
* 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_msg_template?access_token=ACCESS_TOKEN
* <p>
*
* <a href="https://work.weixin.qq.com/api/doc/90000/90135/92135">文档地址</a>
*
* @param wxCpMsgTemplate the wx cp msg template
@@ -733,15 +744,18 @@ public interface WxCpExternalContactService {
/**
* 提醒成员群发
* 企业和第三方应用可调用此接口重新触发群发通知提醒成员完成群发任务24小时内每个群发最多触发三次提醒。
* <p>
*
* 请求方式: POST(HTTPS)
* <p>
*
* 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/remind_groupmsg_send?access_token=ACCESS_TOKEN
* <p>
*
* <a href="https://developer.work.weixin.qq.com/document/path/97610">文档地址</a>
*
* @param msgId 群发消息的id通过获取群发记录列表接口返回
* @return the wx cp msg template add result
* @throws WxErrorException 微信错误异常
*/
WxCpBaseResp remindGroupMsgSend(String msgId) throws WxErrorException;
@@ -753,11 +767,12 @@ public interface WxCpExternalContactService {
* 请求方式: POST(HTTPS)
* <p>
* 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/cancel_groupmsg_send?access_token=ACCESS_TOKEN
* <p>
*
* <a href="https://developer.work.weixin.qq.com/document/path/97611">文档地址</a>
*
* @param msgId 群发消息的id通过获取群发记录列表接口返回
* @return the wx cp msg template add result
* @throws WxErrorException 微信错误异常
*/
WxCpBaseResp cancelGroupMsgSend(String msgId) throws WxErrorException;
@@ -1002,7 +1017,7 @@ public interface WxCpExternalContactService {
/**
* <pre>
* 企业和第三方应用可通过此接口获取企业与成员的群发记录。
* <a href="https://work.weixin.qq.com/api/doc/90000/90135/93338#获取企业群发成员执行结果">获取企业群发成员执行结果</a>
* 文档地址:https://work.weixin.qq.com/api/doc/90000/90135/93338
* </pre>
*
* @param msgid 群发消息的id通过获取群发记录列表接口返回
@@ -1031,7 +1046,7 @@ public interface WxCpExternalContactService {
/**
* <pre>
* 获取群发成员发送任务列表。
* <a href="https://work.weixin.qq.com/api/doc/90000/90135/93338#获取群发成员发送任务列表">获取群发成员发送任务列表</a>
* 文档地址:https://work.weixin.qq.com/api/doc/90000/90135/93338
* </pre>
*
* @param msgid 群发消息的id通过获取群发记录列表接口返回
@@ -1045,7 +1060,7 @@ public interface WxCpExternalContactService {
/**
* <pre>
* 添加入群欢迎语素材。
* <a href="https://open.work.weixin.qq.com/api/doc/90000/90135/92366#添加入群欢迎语素材">添加入群欢迎语素材</a>
* 文档地址:https://open.work.weixin.qq.com/api/doc/90000/90135/92366
* </pre>
*
* @param template 素材内容
@@ -1057,7 +1072,7 @@ public interface WxCpExternalContactService {
/**
* <pre>
* 编辑入群欢迎语素材。
* <a href="https://open.work.weixin.qq.com/api/doc/90000/90135/92366#编辑入群欢迎语素材">编辑入群欢迎语素材</a>
* 文档地址:https://open.work.weixin.qq.com/api/doc/90000/90135/92366
* </pre>
*
* @param template the template
@@ -1069,7 +1084,7 @@ public interface WxCpExternalContactService {
/**
* <pre>
* 获取入群欢迎语素材。
* <a href="https://open.work.weixin.qq.com/api/doc/90000/90135/92366#获取入群欢迎语素材">获取入群欢迎语素材</a>
* 文档地址:https://open.work.weixin.qq.com/api/doc/90000/90135/92366
* </pre>
*
* @param templateId 群欢迎语的素材id
@@ -1082,7 +1097,7 @@ public interface WxCpExternalContactService {
* <pre>
* 删除入群欢迎语素材。
* 企业可通过此API删除入群欢迎语素材且仅能删除调用方自己创建的入群欢迎语素材。
* <a href="https://open.work.weixin.qq.com/api/doc/90000/90135/92366#删除入群欢迎语素材">删除入群欢迎语素材</a>
* 文档地址:https://open.work.weixin.qq.com/api/doc/90000/90135/92366
* </pre>
*
* @param templateId 群欢迎语的素材id
@@ -1094,8 +1109,8 @@ public interface WxCpExternalContactService {
/**
* <pre>
* 获取商品图册
* <a href="https://work.weixin.qq.com/api/doc/90000/90135/95096#获取商品图册列表">获取商品图册列表</a>
* 获取商品图册列表
* 文档地址:https://work.weixin.qq.com/api/doc/90000/90135/95096
* </pre>
*
* @param limit 返回的最大记录数整型最大值100默认值50超过最大值时取默认值
@@ -1108,7 +1123,7 @@ public interface WxCpExternalContactService {
/**
* <pre>
* 获取商品图册
* <a href="https://work.weixin.qq.com/api/doc/90000/90135/95096#获取商品图册">获取商品图册</a>
* 文档地址:https://work.weixin.qq.com/api/doc/90000/90135/95096
* </pre>
*
* @param productId 商品id
@@ -1155,7 +1170,7 @@ public interface WxCpExternalContactService {
* 企业和第三方应用可以通过此接口新建敏感词规则
* 请求方式POST(HTTPS)
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_intercept_rule?access_token=ACCESS_TOKEN
* <pre>
* </pre>
* @param ruleAddRequest the rule add request
* @return 规则id
* @throws WxErrorException the wx error exception
@@ -1169,7 +1184,7 @@ public interface WxCpExternalContactService {
* 企业和第三方应用可以通过此接口修改敏感词规则
* 请求方式POST(HTTPS)
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/externalcontact/update_intercept_rule?access_token=ACCESS_TOKEN
* <pre>
* </pre>
* @param interceptRule the rule
* @throws WxErrorException the wx error exception
*/
@@ -1181,7 +1196,7 @@ public interface WxCpExternalContactService {
* 企业和第三方应用可以通过此接口修改敏感词规则
* 请求方式POST(HTTPS)
* <a href="https://qyapi.weixin.qq.com/cgi-bin/externalcontact/del_intercept_rule?access_token=ACCESS_TOKEN">请求地址</a>
* <pre>
* </pre>
* @param ruleId 规则id
* @throws WxErrorException the wx error exception
*/
@@ -1220,7 +1235,7 @@ public interface WxCpExternalContactService {
* 请求地址:
* <a href="https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_product_album?access_token=ACCESS_TOKEN">https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_product_album?access_token=ACCESS_TOKEN</a>
* <a href="https://developer.work.weixin.qq.com/document/path/95096#%E5%88%9B%E5%BB%BA%E5%95%86%E5%93%81%E5%9B%BE%E5%86%8C">文档地址</a>
* <pre>
* </pre>
* @param wxCpProductAlbumInfo 商品图册信息
* @return 商品id string
* @throws WxErrorException the wx error exception
@@ -1235,7 +1250,7 @@ public interface WxCpExternalContactService {
* 请求地址:
* <a href="https://qyapi.weixin.qq.com/cgi-bin/externalcontact/update_product_album?access_token=ACCESS_TOKEN">https://qyapi.weixin.qq.com/cgi-bin/externalcontact/update_product_album?access_token=ACCESS_TOKEN</a>
* <a href="https://developer.work.weixin.qq.com/document/path/95096#%E7%BC%96%E8%BE%91%E5%95%86%E5%93%81%E5%9B%BE%E5%86%8C">文档地址</a>
* <pre>
* </pre>
* @param wxCpProductAlbumInfo 商品图册信息
* @throws WxErrorException the wx error exception
*/
@@ -1250,7 +1265,7 @@ public interface WxCpExternalContactService {
* <a href="https://qyapi.weixin.qq.com/cgi-bin/externalcontact/delete_product_album?access_token=ACCESS_TOKEN">https://qyapi.weixin.qq.com/cgi-bin/externalcontact/delete_product_album?access_token=ACCESS_TOKEN</a>
*
* <a href="https://developer.work.weixin.qq.com/document/path/95096#%E5%88%A0%E9%99%A4%E5%95%86%E5%93%81%E5%9B%BE%E5%86%8C">文档地址</a>
* <pre>
* </pre>
* @param productId 商品id
* @throws WxErrorException the wx error exception
*/
@@ -1379,7 +1394,7 @@ public interface WxCpExternalContactService {
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/externalcontact/customer_acquisition/statistic?access_token=ACCESS_TOKEN
*
* @author Hugo
* @date 2023/12/5 14:34
* @since 2023/12/5 14:34
* @param linkId 获客链接的id
* @param startTime 统计起始时间
* @param endTime 统计结束时间

View File

@@ -126,9 +126,10 @@ public interface WxCpGroupRobotService {
/**
* 发送模板卡片消息
* @param webhookUrl
* @param wxCpGroupRobotMessage
* @throws WxErrorException
*
* @param webhookUrl webhook地址
* @param wxCpGroupRobotMessage 群机器人消息
* @throws WxErrorException 异常
*/
void sendTemplateCardMessage(String webhookUrl, WxCpGroupRobotMessage wxCpGroupRobotMessage) throws WxErrorException;

View File

@@ -222,7 +222,7 @@ public interface WxCpKfService {
* <a href="https://qyapi.weixin.qq.com/cgi-bin/kf/get_corp_statistic?access_token=ACCESS_TOKEN">https://qyapi.weixin.qq.com/cgi-bin/kf/get_corp_statistic?access_token=ACCESS_TOKEN</a>
* 文档地址:
* <a href="https://developer.work.weixin.qq.com/document/path/95489">https://developer.work.weixin.qq.com/document/path/95489</a>
* <pre>
* </pre>
* @param request 查询参数
* @return 客户数据统计 -企业汇总数据
* @throws WxErrorException the wx error exception
@@ -238,7 +238,7 @@ public interface WxCpKfService {
* <a href="https://qyapi.weixin.qq.com/cgi-bin/kf/get_servicer_statistic?access_token=ACCESS_TOKEN">https://qyapi.weixin.qq.com/cgi-bin/kf/get_servicer_statistic?access_token=ACCESS_TOKEN</a>
* 文档地址:
* <a href="https://developer.work.weixin.qq.com/document/path/95490">https://developer.work.weixin.qq.com/document/path/95490</a>
* <pre>
* </pre>
* @param request 查询参数
* @return 客户数据统计 -企业汇总数据
* @throws WxErrorException the wx error exception

View File

@@ -27,7 +27,7 @@ public interface WxCpLivingService {
/**
* 获取直播详情
* 请求方式GETHTTPS
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/living/get_living_info?access_token=ACCESS_TOKEN&livingid=LIVINGID
* {@code 请求地址https://qyapi.weixin.qq.com/cgi-bin/living/get_living_info?access_token=ACCESS_TOKEN&livingid=LIVINGID}
*
* @param livingId 直播id
* @return 获取的直播详情 living info

View File

@@ -110,9 +110,9 @@ public interface WxCpMediaService {
* 获取高清语音素材.
* 可以使用本接口获取从JSSDK的uploadVoice接口上传的临时语音素材格式为speex16K采样率。该音频比上文的临时素材获取接口格式为amr8K采样率更加清晰适合用作语音识别等对音质要求较高的业务。
* 请求方式GETHTTPS
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/media/get/jssdk?access_token=ACCESS_TOKEN&media_id=MEDIA_ID
* {@code 请求地址https://qyapi.weixin.qq.com/cgi-bin/media/get/jssdk?access_token=ACCESS_TOKEN&media_id=MEDIA_ID}
* 仅企业微信2.4及以上版本支持。
* 文档地址https://work.weixin.qq.com/api/doc#90000/90135/90255
* 文档地址https://work.weixin.qq.com/api/doc/90000/90135/90255
* </pre>
*
* @param mediaId 媒体id

View File

@@ -72,8 +72,9 @@ public interface WxCpMessageService {
* 请求地址: https://qyapi.weixin.qq.com/cgi-bin/message/recall?access_token=ACCESS_TOKEN
* 文档地址: https://developer.work.weixin.qq.com/document/path/94867
* </pre>
*
* @param msgId 消息id
* @throws WxErrorException
* @throws WxErrorException 异常
*/
void recall(String msgId) throws WxErrorException;

View File

@@ -90,9 +90,10 @@ public interface WxCpOAuth2Service {
/**
* 获取家校访问用户身份
* 该接口用于根据code获取家长或者学生信息
* <p>
* <pre>
* 请求方式GETHTTPS
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/school/getuserinfo?access_token=ACCESS_TOKEN&code=CODE
* {@code 请求地址https://qyapi.weixin.qq.com/cgi-bin/school/getuserinfo?access_token=ACCESS_TOKEN&code=CODE}
* </pre>
*
* @param code the code
* @return school user info
@@ -123,7 +124,7 @@ public interface WxCpOAuth2Service {
/**
* <pre>
* 获取用户登录身份
* https://qyapi.weixin.qq.com/cgi-bin/auth/getuserinfo?access_token=ACCESS_TOKEN&code=CODE
* {@code https://qyapi.weixin.qq.com/cgi-bin/auth/getuserinfo?access_token=ACCESS_TOKEN&code=CODE}
* 该接口可使用用户登录成功颁发的code来获取成员信息适用于自建应用与代开发应用
*
* 注意: 旧的/user/getuserinfo 接口的url已变更为auth/getuserinfo不过旧接口依旧可以使用建议是关注新接口即可
@@ -140,13 +141,15 @@ public interface WxCpOAuth2Service {
/**
* 获取用户二次验证信息
* <p>
* <pre>
* api: https://qyapi.weixin.qq.com/cgi-bin/auth/get_tfa_info?access_token=ACCESS_TOKEN
* 权限说明:仅『通讯录同步』或者自建应用可调用,如用自建应用调用,用户需要在二次验证范围和应用可见范围内。
* 并发限制20
* </pre>
*
* @param code 用户进入二次验证页面时企业微信颁发的code,每次成员授权带上的code将不一样code只能使用一次5分钟未被使用自动过期
* @return me.chanjar.weixin.cp.bean.workbench.WxCpSecondVerificationInfo 二次验证授权码,开发者可以调用通过二次验证接口,解锁企业微信终端.tfa_code有效期五分钟且只能使用一次。
* @return 二次验证授权码,开发者可以调用通过二次验证接口,解锁企业微信终端.tfa_code有效期五分钟且只能使用一次。
* @throws WxErrorException 微信错误异常
*/
WxCpSecondVerificationInfo getTfaInfo(String code) throws WxErrorException;
}

View File

@@ -84,6 +84,7 @@ public interface WxCpOaMeetingRoomService {
* </pre>
*
* @param wxCpOaMeetingRoomBookingInfoRequest 会议室预定信息查询对象
* @return 会议室预定信息
* @throws WxErrorException .
*/
WxCpOaMeetingRoomBookingInfoResult getMeetingRoomBookingInfo(WxCpOaMeetingRoomBookingInfoRequest wxCpOaMeetingRoomBookingInfoRequest) throws WxErrorException;
@@ -99,6 +100,7 @@ public interface WxCpOaMeetingRoomService {
* </pre>
*
* @param wxCpOaMeetingRoomBookRequest 会议室预定对象
* @return 预定结果
* @throws WxErrorException .
*/
WxCpOaMeetingRoomBookResult bookingMeetingRoom(WxCpOaMeetingRoomBookRequest wxCpOaMeetingRoomBookRequest) throws WxErrorException;
@@ -114,6 +116,7 @@ public interface WxCpOaMeetingRoomService {
* </pre>
*
* @param wxCpOaMeetingRoomBookByScheduleRequest 会议室预定对象
* @return 预定结果
* @throws WxErrorException .
*/
WxCpOaMeetingRoomBookResult bookingMeetingRoomBySchedule(WxCpOaMeetingRoomBookByScheduleRequest wxCpOaMeetingRoomBookByScheduleRequest) throws WxErrorException;
@@ -129,6 +132,7 @@ public interface WxCpOaMeetingRoomService {
* </pre>
*
* @param wxCpOaMeetingRoomBookByMeetingRequest 会议室预定对象
* @return 预定结果
* @throws WxErrorException .
*/
WxCpOaMeetingRoomBookResult bookingMeetingRoomByMeeting(WxCpOaMeetingRoomBookByMeetingRequest wxCpOaMeetingRoomBookByMeetingRequest) throws WxErrorException;
@@ -147,10 +151,10 @@ public interface WxCpOaMeetingRoomService {
* @param wxCpOaMeetingRoomCancelBookRequest 取消预定会议室对象
* @throws WxErrorException .
*/
void cancelBookMeetingRoom(WxCpOaMeetingRoomCancelBookRequest wxCpOaMeetingRoomCancelBookRequest) throws WxErrorException;
void cancelBookMeetingRoom(WxCpOaMeetingRoomCancelBookRequest wxCpOaMeetingRoomCancelBookRequest) throws WxErrorException;
/**
/**
* 根据会议室预定ID查询预定详情.
* <pre>
* 企业可通过此接口根据预定id查询相关会议室的预定情况
@@ -161,8 +165,9 @@ public interface WxCpOaMeetingRoomService {
* </pre>
*
* @param wxCpOaMeetingRoomBookingInfoByBookingIdRequest 根据会议室预定ID查询预定详情对象
* @return 预定详情
* @throws WxErrorException .
*/
WxCpOaMeetingRoomBookingInfoByBookingIdResult getBookingInfoByBookingId(WxCpOaMeetingRoomBookingInfoByBookingIdRequest wxCpOaMeetingRoomBookingInfoByBookingIdRequest) throws WxErrorException;
WxCpOaMeetingRoomBookingInfoByBookingIdResult getBookingInfoByBookingId(WxCpOaMeetingRoomBookingInfoByBookingIdRequest wxCpOaMeetingRoomBookingInfoByBookingIdRequest) throws WxErrorException;
}

View File

@@ -11,7 +11,8 @@ import java.util.List;
/**
* 企业微信OA相关接口.
*
* @author Element & Wang_Wong created on 2019-04-06 10:52
* @author Element, Wang_Wong
* @since 2019-04-06 10:52
*/
public interface WxCpOaService {
@@ -331,7 +332,7 @@ public interface WxCpOaService {
* <a href="https://qyapi.weixin.qq.com/cgi-bin/checkin/addcheckinuserface?access_token=ACCESS_TOKEN">https://qyapi.weixin.qq.com/cgi-bin/checkin/addcheckinuserface?access_token=ACCESS_TOKEN</a>
* 文档地址:
* <a href="https://developer.work.weixin.qq.com/document/path/93378">https://developer.work.weixin.qq.com/document/path/93378</a>
* <pre>
* </pre>
* @param userId 需要录入的用户id
* @param userFace 需要录入的人脸图片数据需要将图片数据base64处理后填入对已录入的人脸会进行更新处理
* @throws WxErrorException the wx error exception

View File

@@ -80,9 +80,10 @@ public interface WxCpSchoolService {
/**
* 获取直播详情
* <pre>
* 请求方式GETHTTPS
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/school/living/get_living_info?access_token=ACCESS_TOKEN&livingid
* =LIVINGID
* {@code 请求地址https://qyapi.weixin.qq.com/cgi-bin/school/living/get_living_info?access_token=ACCESS_TOKEN&livingid=LIVINGID}
* </pre>
*
* @param livingId the living id
* @return living info

View File

@@ -19,9 +19,10 @@ public interface WxCpSchoolUserService {
/**
* 获取访问用户身份
* 该接口用于根据code获取成员信息
* <p>
* <pre>
* 请求方式GETHTTPS
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/user/getuserinfo?access_token=ACCESS_TOKEN&code=CODE
* {@code 请求地址https://qyapi.weixin.qq.com/cgi-bin/user/getuserinfo?access_token=ACCESS_TOKEN&code=CODE}
* </pre>
*
* @param code the code
* @return user info
@@ -32,9 +33,10 @@ public interface WxCpSchoolUserService {
/**
* 获取家校访问用户身份
* 该接口用于根据code获取家长或者学生信息
* <p>
* <pre>
* 请求方式GETHTTPS
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/school/getuserinfo?access_token=ACCESS_TOKEN&code=CODE
* {@code 请求地址https://qyapi.weixin.qq.com/cgi-bin/school/getuserinfo?access_token=ACCESS_TOKEN&code=CODE}
* </pre>
*
* @param code the code
* @return school user info
@@ -90,8 +92,10 @@ public interface WxCpSchoolUserService {
/**
* 删除学生
* <pre>
* 请求方式GETHTTPS
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_student?access_token=ACCESS_TOKEN&userid=USERID
* {@code 请求地址https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_student?access_token=ACCESS_TOKEN&userid=USERID}
* </pre>
*
* @param studentUserId the student user id
* @return wx cp base resp
@@ -160,8 +164,10 @@ public interface WxCpSchoolUserService {
/**
* 读取学生或家长
* <pre>
* 请求方式GETHTTPS
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/school/user/get?access_token=ACCESS_TOKEN&userid=USERID
* {@code 请求地址https://qyapi.weixin.qq.com/cgi-bin/school/user/get?access_token=ACCESS_TOKEN&userid=USERID}
* </pre>
*
* @param userId the user id
* @return user
@@ -171,9 +177,10 @@ public interface WxCpSchoolUserService {
/**
* 获取部门成员详情
* <pre>
* 请求方式GETHTTPS
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/school/user/list?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID
* &fetch_child=FETCH_CHILD
* {@code 请求地址https://qyapi.weixin.qq.com/cgi-bin/school/user/list?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID&fetch_child=FETCH_CHILD}
* </pre>
*
* @param departmentId 获取的部门id
* @param fetchChild 1/0是否递归获取子部门下面的成员
@@ -184,9 +191,10 @@ public interface WxCpSchoolUserService {
/**
* 获取部门家长详情
* <pre>
* 请求方式GETHTTPS
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/school/user/list_parent?access_token=ACCESS_TOKEN&department_id
* =DEPARTMENT_ID
* {@code 请求地址https://qyapi.weixin.qq.com/cgi-bin/school/user/list_parent?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID}
* </pre>
*
* @param departmentId 获取的部门id
* @return user list parent
@@ -207,8 +215,10 @@ public interface WxCpSchoolUserService {
/**
* 删除家长
* <pre>
* 请求方式GETHTTPS
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_parent?access_token=ACCESS_TOKEN&userid=USERID
* {@code 请求地址https://qyapi.weixin.qq.com/cgi-bin/school/user/delete_parent?access_token=ACCESS_TOKEN&userid=USERID}
* </pre>
*
* @param userId the user id
* @return wx cp base resp
@@ -256,7 +266,7 @@ public interface WxCpSchoolUserService {
/**
* 删除部门
* 请求方式GETHTTPS
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/school/department/delete?access_token=ACCESS_TOKEN&id=ID
* {@code 请求地址https://qyapi.weixin.qq.com/cgi-bin/school/department/delete?access_token=ACCESS_TOKEN&id=ID}
*
* @param id the id
* @return wx cp base resp
@@ -292,10 +302,9 @@ public interface WxCpSchoolUserService {
/**
* 获取外部联系人详情
* 学校可通过此接口根据外部联系人的userid如何获取?),拉取外部联系人详情。
* <p>
*
* 请求方式GETHTTPS
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get?access_token=ACCESS_TOKEN&external_userid
* =EXTERNAL_USERID
* {@code 请求地址https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get?access_token=ACCESS_TOKEN&external_userid=EXTERNAL_USERID}
*
* @param externalUserId 外部联系人的userid注意不是学校成员的帐号
* @return external contact
@@ -306,9 +315,9 @@ public interface WxCpSchoolUserService {
/**
* 获取可使用的家长范围
* 获取可在微信「学校通知-学校应用」使用该应用的家长范围,以学生或部门列表的形式返回。应用只能给该列表下的家长发送「学校通知」。注意该范围只能由学校的系统管理员在「管理端-家校沟通-配置」配置。
* <p>
*
* 请求方式GETHTTPS
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/school/agent/get_allow_scope?access_token=ACCESS_TOKEN&agentid=AGENTID
* {@code 请求地址https://qyapi.weixin.qq.com/cgi-bin/school/agent/get_allow_scope?access_token=ACCESS_TOKEN&agentid=AGENTID}
*
* @param agentId the agent id
* @return allow scope
@@ -332,7 +341,7 @@ public interface WxCpSchoolUserService {
/**
* 获取部门列表
* 请求方式GETHTTPS
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/school/department/list?access_token=ACCESS_TOKEN&id=ID
* {@code 请求地址https://qyapi.weixin.qq.com/cgi-bin/school/department/list?access_token=ACCESS_TOKEN&id=ID}
*
* @param id 部门id。获取指定部门及其下的子部门。 如果不填,默认获取全量组织架构
* @return wx cp department list

View File

@@ -584,7 +584,7 @@ public interface WxCpService extends WxService {
/**
* 企业互联的服务类对象
*
* @return
* @return 企业互联服务对象
*/
WxCpCorpGroupService getCorpGroupService();

View File

@@ -38,7 +38,7 @@ public interface WxCpUserService {
* <pre>
* 获取部门成员详情
* 请求方式GETHTTPS
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/user/list?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID&fetch_child=FETCH_CHILD
* {@code 请求地址https://qyapi.weixin.qq.com/cgi-bin/user/list?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID&fetch_child=FETCH_CHILD}
*
* 文档地址https://work.weixin.qq.com/api/doc/90000/90135/90201
* </pre>
@@ -213,7 +213,7 @@ public interface WxCpUserService {
* 获取加入企业二维码。
*
* 请求方式GETHTTPS
* 请求地址https://qyapi.weixin.qq.com/cgi-bin/corp/get_join_qrcode?access_token=ACCESS_TOKEN&size_type=SIZE_TYPE
* {@code 请求地址https://qyapi.weixin.qq.com/cgi-bin/corp/get_join_qrcode?access_token=ACCESS_TOKEN&size_type=SIZE_TYPE}
*
* 文档地址https://work.weixin.qq.com/api/doc/90000/90135/91714
* </pre>

View File

@@ -18,7 +18,7 @@ import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.CorpGroup.LIST_SHA
* 企业互联相关接口实现类
*
* @author libo <422423229@qq.com>
* Created on 27/2/2023 9:57 PM
* @since 2023-02-27 9:57 PM
*/
@RequiredArgsConstructor
public class WxCpCorpGroupServiceImpl implements WxCpCorpGroupService {

View File

@@ -38,7 +38,7 @@ import org.apache.commons.lang3.StringUtils;
/**
* The type Wx cp external contact service.
*
* @author 曹祖鹏 & yuanqixun & Mr.Pan & Wang_Wong
* @author 曹祖鹏, yuanqixun, Mr.Pan, Wang_Wong
*/
@RequiredArgsConstructor
public class WxCpExternalContactServiceImpl implements WxCpExternalContactService {

View File

@@ -10,7 +10,8 @@ import java.io.Serializable;
/**
* 返回结果
*
* @author yqx & WangWong created on 2020/3/16
* @author yqx, WangWong
* @since 2020/3/16
*/
@Getter
@Setter

View File

@@ -216,7 +216,7 @@ public class WxCpTpAuthInfo extends WxCpBaseResp {
/**
* 付费状态
* <br/>
* <br>
* <ul>
* <li>0-没有付费;</li>
* <li>1-限时试用;</li>

View File

@@ -225,7 +225,7 @@ public class WxCpTpPermanentCodeInfo extends WxCpBaseResp {
/**
* 付费状态
* <br/>
* <br>
* <ul>
* <li>0-没有付费;</li>
* <li>1-限时试用;</li>

View File

@@ -10,7 +10,7 @@ import java.io.Serializable;
* The type Wx cp tp tag.
*
* @author zhangq <zhangq002@gmail.com>
* @since 2021 -02-14 16:15 16:15
* @since 2021-02-14 16:15
*/
@Data
public class WxCpTpTag implements Serializable {

View File

@@ -6,7 +6,7 @@ import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
* 企业微信第三方开发-增加标签成员成员api响应体
*
* @author zhangq <zhangq002@gmail.com>
* @since 2021 /2/14 16:44
* @since 2021/2/14 16:44
*/
public class WxCpTpTagAddOrRemoveUsersResult extends WxCpTagAddOrRemoveUsersResult {
private static final long serialVersionUID = 3490401800490702052L;

View File

@@ -6,7 +6,7 @@ import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
* 获取标签成员接口响应体
*
* @author zhangq <zhangq002@gmail.com>
* @since 2021 /2/14 16:28
* @since 2021/2/14 16:28
*/
public class WxCpTpTagGetResult extends WxCpTagGetResult {
private static final long serialVersionUID = 9051748686315562400L;

View File

@@ -14,10 +14,9 @@ import java.util.List;
/**
* 企业群发消息任务
* <p>
* Created by songfan on 2020/7/14.
*
* @author songfan & Mr.Pan
* @author songfan, Mr.Pan
* @since 2020/7/14
*/
@Data
@Builder

View File

@@ -12,7 +12,8 @@ import java.util.List;
/**
* 离职员工外部联系人列表
*
* @author yqx & Wang_Wong created on 2020/3/15
* @author yqx, Wang_Wong
* @since 2020/3/15
*/
@Getter
@Setter

View File

@@ -10,7 +10,7 @@ import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
* 获客链接的使用详情
*
* @author Hugo
* @date 2023/12/11 10:31
* @since 2023/12/11 10:31
*/
@Data
@EqualsAndHashCode(callSuper = true)

View File

@@ -10,9 +10,10 @@ import java.io.Serializable;
import java.util.List;
/**
* @Date: 2024-03-07 17:02
* @Author shenliuming
* @return
* 防骚扰规则详情
*
* @author shenliuming
* @since 2024-03-07 17:02
*/
@Data
@EqualsAndHashCode(callSuper = true)

View File

@@ -9,9 +9,10 @@ import java.io.Serializable;
import java.util.List;
/**
* @Date: 2024-03-07 15:54
* @Author shenliuming
* @return
* 防骚扰规则列表
*
* @author shenliuming
* @since 2024-03-07 15:54
*/
@Data
@EqualsAndHashCode(callSuper = true)

View File

@@ -33,6 +33,7 @@ public class Attachment implements Serializable {
* Sets image.
*
* @param image the image
* @return this
*/
public Attachment setImage(Image image) {
this.image = image;
@@ -44,6 +45,7 @@ public class Attachment implements Serializable {
* Sets link.
*
* @param link the link
* @return this
*/
public Attachment setLink(Link link) {
this.link = link;
@@ -55,6 +57,7 @@ public class Attachment implements Serializable {
* Sets mini program.
*
* @param miniProgram the mini program
* @return this
*/
public Attachment setMiniProgram(MiniProgram miniProgram) {
this.miniProgram = miniProgram;
@@ -66,6 +69,7 @@ public class Attachment implements Serializable {
* Sets video.
*
* @param video the video
* @return this
*/
public Attachment setVideo(Video video) {
this.video = video;
@@ -77,6 +81,7 @@ public class Attachment implements Serializable {
* Sets file.
*
* @param file the file
* @return this
*/
public Attachment setFile(File file) {
this.file = file;

View File

@@ -27,10 +27,10 @@ public class WxCpKfAccountLink implements Serializable {
* 场景值,字符串类型,由开发者自定义。
* 不多于32字节
* 字符串取值范围(正则表达式)[0-9a-zA-Z_-]*
* <p>
*
* 1. 若scene非空返回的客服链接开发者可拼接scene_param=SCENE_PARAM参数使用用户进入会话事件会将SCENE_PARAM原样返回。
* 其中SCENE_PARAM需要urlencode且长度不能超过128字节。
* 如 https://work.weixin.qq.com/kf/kfcbf8f8d07ac7215f?enc_scene=ENCGFSDF567DF&scene_param=a%3D1%26b%3D2
* {@code 如 https://work.weixin.qq.com/kf/kfcbf8f8d07ac7215f?enc_scene=ENCGFSDF567DF&scene_param=a%3D1%26b%3D2}
* 2. 历史调用接口返回的客服链接包含encScene=XXX参数不支持scene_param参数。
* 3. 返回的客服链接,不能修改或复制参数到其他链接使用。否则进入会话事件参数校验不通过,导致无法回调。
*/

View File

@@ -5,8 +5,9 @@ import me.chanjar.weixin.cp.util.json.WxCpGsonBuilder;
/**
* 生成异步上传任务
*
* @author <a href="https://github.com/imyzt">imyzt</a>
* @date 2025/04/27
* @since 2025/04/27
*/
@Data
public class MediaUploadByUrlReq {

View File

@@ -10,8 +10,9 @@ import java.io.Serializable;
/**
* 异步上传企微素材
*
* @author <a href="https://github.com/imyzt">imyzt</a>
* @date 2025/4/27
* @since 2025/4/27
*/
@EqualsAndHashCode(callSuper = true)
@Data

View File

@@ -85,13 +85,13 @@ public class WxCpLinkedCorpMessage implements Serializable {
/**
* <pre>
* 请使用.
* {@link LinkedCorpMsgType#TEXT}
* {@link LinkedCorpMsgType#IMAGE}
* {@link LinkedCorpMsgType#VIDEO}
* {@link LinkedCorpMsgType#NEWS}
* {@link LinkedCorpMsgType#MPNEWS}
* {@link LinkedCorpMsgType#MARKDOWN}
* {@link LinkedCorpMsgType#MINIPROGRAM_NOTICE}
* {@link me.chanjar.weixin.cp.constant.WxCpConsts.LinkedCorpMsgType#TEXT}
* {@link me.chanjar.weixin.cp.constant.WxCpConsts.LinkedCorpMsgType#IMAGE}
* {@link me.chanjar.weixin.cp.constant.WxCpConsts.LinkedCorpMsgType#VIDEO}
* {@link me.chanjar.weixin.cp.constant.WxCpConsts.LinkedCorpMsgType#NEWS}
* {@link me.chanjar.weixin.cp.constant.WxCpConsts.LinkedCorpMsgType#MPNEWS}
* {@link me.chanjar.weixin.cp.constant.WxCpConsts.LinkedCorpMsgType#MARKDOWN}
* {@link me.chanjar.weixin.cp.constant.WxCpConsts.LinkedCorpMsgType#MINIPROGRAM_NOTICE}
* </pre>
*
* @param msgType 消息类型

View File

@@ -68,19 +68,19 @@ public class WxCpXmlMessage implements Serializable {
/**
* <pre>
* 当接受用户消息时,可能会获得以下值:
* {@link WxConsts.XmlMsgType#TEXT}
* {@link WxConsts.XmlMsgType#IMAGE}
* {@link WxConsts.XmlMsgType#VOICE}
* {@link WxConsts.XmlMsgType#VIDEO}
* {@link WxConsts.XmlMsgType#LOCATION}
* {@link WxConsts.XmlMsgType#LINK}
* {@link WxConsts.XmlMsgType#EVENT}
* {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#TEXT}
* {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#IMAGE}
* {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#VOICE}
* {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#VIDEO}
* {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#LOCATION}
* {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#LINK}
* {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#EVENT}
* 当发送消息的时候使用:
* {@link WxConsts.XmlMsgType#TEXT}
* {@link WxConsts.XmlMsgType#IMAGE}
* {@link WxConsts.XmlMsgType#VOICE}
* {@link WxConsts.XmlMsgType#VIDEO}
* {@link WxConsts.XmlMsgType#NEWS}
* {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#TEXT}
* {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#IMAGE}
* {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#VOICE}
* {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#VIDEO}
* {@link me.chanjar.weixin.common.api.WxConsts.XmlMsgType#NEWS}
* </pre>
*/
@XStreamAlias("MsgType")

View File

@@ -12,7 +12,8 @@ import java.util.List;
* 用法: WxCustomMessage m = WxCustomMessage.TEMPLATECARD().title(...)....toUser(...).build();
* </pre>
*
* @author yzts</ a> created on 2019-05-16
* @author yzts
* @since 2019-05-16
*/
public class TemplateCardBuilder extends BaseBuilder<TemplateCardBuilder> {
/**

View File

@@ -10,8 +10,8 @@ import java.util.List;
* 打卡规则基础信息
*
* @author zhongjun96
* @date 2023/7/7
**/
* @since 2023/7/7
*/
@Data
public class WxCpCheckinGroupBase implements Serializable {

View File

@@ -157,7 +157,7 @@ public class WxCpOaSchedule implements Serializable, ToJson {
/**
* 提醒时间与日程开始时间start_time的差值当is_remind为1时有效。例如-300表示日程开始前5分钟提醒。
* 特殊情况企业微信终端设置的“全天”类型的日程由于start_time是0点时间戳提醒如果设置了当天9点则会出现正数32400。
* <br/>
* <br>
* 取值范围:-604800 ~ 86399
*/
@SerializedName("remind_time_diffs")

View File

@@ -39,7 +39,7 @@ public class WxCpOaMeetingRoomBookResult extends WxCpBaseResp implements Seriali
private String schedule_id;
/**
* 通过会议预定会议室 和 通过日程预定会议室 接口返回
* <br/>
* <br>
* 会议室冲突日期列表为当天0点的时间戳使用重复会议预定会议室部分日期与会议室预定情况冲突时返回
*/
@SerializedName("conflict_date")

View File

@@ -8,7 +8,7 @@ import java.util.List;
/**
* @author mrsiu@msn.com
* @version 1.0
* @date 2025/1/16 09:40
* @since 2025/1/16 09:40
*/
@Data
public class TemplateTips {

View File

@@ -5,7 +5,7 @@ import lombok.Data;
/**
* @author mrsiu@msn.com
* @version 1.0
* @date 2025/1/16 09:42
* @since 2025/1/16 09:42
*/
@Data
public class TemplateTipsContent {

View File

@@ -5,7 +5,7 @@ import lombok.Data;
/**
* @author mrsiu@msn.com
* @version 1.0
* @date 2025/1/16 09:45
* @since 2025/1/16 09:45
*/
@Data
public class TemplateTipsSubText {

View File

@@ -6,7 +6,7 @@ import lombok.Data;
/**
* @author mrsiu@msn.com
* @version 1.0
* @date 2025/1/16 09:46
* @since 2025/1/16 09:46
*/
@Data
public class TemplateTipsSubTextContent {

View File

@@ -5,7 +5,7 @@ import lombok.Data;
/**
* @author mrsiu@msn.com
* @version 1.0
* @date 2025/1/16 09:49
* @since 2025/1/16 09:49
*/
@Data
public class TemplateTipsSubTextContentLink {

View File

@@ -3,9 +3,9 @@ package me.chanjar.weixin.cp.bean.oa.templatedata;
import lombok.Data;
/**
* @author mrsiu@msn.com
* @date 2025/1/16 09:47
* @version 1.0
* @author mrsiu@msn.com
* @version 1.0
* @since 2025/1/16 09:47
*/
@Data
public class TemplateTipsSubTextContentPlainText {

View File

@@ -6,9 +6,9 @@ import lombok.Data;
import java.util.List;
/**
* @author mrsiu@msn.com
* @date 2025/1/16 09:43
* @version 1.0
* @author mrsiu@msn.com
* @version 1.0
* @since 2025/1/16 09:43
*/
@Data
public class TemplateTipsText {

View File

@@ -31,8 +31,8 @@ public interface WxCpCorpGroupConfigStorage {
/**
* Update corp access token.
*
* @param corpId
* @param agentId
* @param corpId 企业ID
* @param agentId 应用ID
* @param corpAccessToken the corp access token
* @param expiresInSeconds the expires in seconds
*/
@@ -41,8 +41,8 @@ public interface WxCpCorpGroupConfigStorage {
/**
* 授权企业的access token相关
*
* @param corpId the corp id
* @param agentId
* @param corpId 企业ID
* @param agentId 应用ID
* @return the access token
*/
String getCorpAccessToken(String corpId, Integer agentId);
@@ -50,8 +50,8 @@ public interface WxCpCorpGroupConfigStorage {
/**
* Gets access token entity.
*
* @param corpId the corp id
* @param agentId
* @param corpId 企业ID
* @param agentId 应用ID
* @return the access token entity
*/
WxAccessToken getCorpAccessTokenEntity(String corpId, Integer agentId);
@@ -59,8 +59,8 @@ public interface WxCpCorpGroupConfigStorage {
/**
* Is access token expired boolean.
*
* @param corpId the corp id
* @param agentId
* @param corpId 企业ID
* @param agentId 应用ID
* @return the boolean
*/
boolean isCorpAccessTokenExpired(String corpId, Integer agentId);
@@ -68,8 +68,8 @@ public interface WxCpCorpGroupConfigStorage {
/**
* Expire access token.
*
* @param corpId the corp id
* @param agentId
* @param corpId 企业ID
* @param agentId 应用ID
*/
void expireCorpAccessToken(String corpId, Integer agentId);
@@ -118,7 +118,8 @@ public interface WxCpCorpGroupConfigStorage {
/**
* Gets access token lock.
*
* @param corpId the corp id
* @param corpId 企业ID
* @param agentId 应用ID
* @return the access token lock
*/
Lock getCorpAccessTokenLock(String corpId, Integer agentId);

View File

@@ -133,7 +133,7 @@ public interface WxCpTpConfigStorage {
String getEncodingAESKey();
/**
* 企微服务商企业ID & 企业secret
* {@code 企微服务商企业ID & 企业secret}
*
* @return the corp id
*/

View File

@@ -187,7 +187,9 @@ public abstract class AbstractWxCpTpInRedisConfigImpl extends WxCpTpDefaultConfi
/**
* 企微服务商企业ID & 企业secret, 来自于企微配置
* {@code 企微服务商企业ID & 企业secret, 来自于企微配置}
*
* @return 企业ID
*/
@Override
public String getCorpId() {

View File

@@ -29,7 +29,7 @@ public class WxCpTpDefaultConfigImpl implements WxCpTpConfigStorage, Serializabl
private final transient Map<String, Lock> authCorpJsapiTicketLocker = new ConcurrentHashMap<>();
private final transient Map<String, Lock> authSuiteJsapiTicketLocker = new ConcurrentHashMap<>();
/**
* 企微服务商企业ID & 企业secret来自于企微配置
* {@code 企微服务商企业ID & 企业secret来自于企微配置}
*/
protected volatile String corpId;
/**
@@ -198,7 +198,7 @@ public class WxCpTpDefaultConfigImpl implements WxCpTpConfigStorage, Serializabl
/**
* Sets suite id.
*
* @param suiteId
* @param suiteId 套件ID
*/
public void setSuiteId(String suiteId) {
this.suiteId = suiteId;
@@ -211,6 +211,8 @@ public class WxCpTpDefaultConfigImpl implements WxCpTpConfigStorage, Serializabl
/**
* Sets suite secret.
*
* @param corpSecret 套件密钥
*/
public void setSuiteSecret(String corpSecret) {
this.suiteSecret = corpSecret;

View File

@@ -124,7 +124,7 @@ public class WxCpConsts {
public static final String REOPEN_INACTIVE_AGENT = "reopen_inactive_agent";
/**
* 企业成员添加外部联系人事件推送 & 会话存档客户同意进行聊天内容存档事件回调事件
* {@code 企业成员添加外部联系人事件推送 & 会话存档客户同意进行聊天内容存档事件回调事件}
*/
public static final String CHANGE_EXTERNAL_CONTACT = "change_external_contact";

View File

@@ -33,28 +33,31 @@ public interface WxCpCgService {
/**
* 授权企业的access token相关
*
* @param corpId the corp id
* @param agentId
* @param businessType
* @param corpId 企业ID
* @param agentId 应用ID
* @param businessType 业务类型
* @return the access token
* @throws WxErrorException 微信错误异常
*/
WxAccessToken getCorpAccessTokenEntity(String corpId, Integer agentId, Integer businessType) throws WxErrorException;
/**
* Gets access token entity.
*
* @param corpId the corp id
* @param agentId
* @param businessType
* @param corpId 企业ID
* @param agentId 应用ID
* @param businessType 业务类型
* @param forceRefresh 是否强制刷新
* @return the access token entity
* @throws WxErrorException 微信错误异常
*/
WxAccessToken getCorpAccessTokenEntity(String corpId, Integer agentId, Integer businessType, boolean forceRefresh) throws WxErrorException;
/**
* Is access token expired boolean.
*
* @param corpId the corp id
* @param agentId
* @param corpId 企业ID
* @param agentId 应用ID
* @return the boolean
*/
boolean isCorpAccessTokenExpired(String corpId, Integer agentId);
@@ -62,8 +65,8 @@ public interface WxCpCgService {
/**
* Expire access token.
*
* @param corpId the corp id
* @param agentId
* @param corpId 企业ID
* @param agentId 应用ID
*/
void expireCorpAccessToken(String corpId, Integer agentId);
@@ -72,6 +75,7 @@ public interface WxCpCgService {
*
* @param url 接口地址
* @param queryParam 请求参数
* @param req 获取token请求参数
* @return the string
* @throws WxErrorException the wx error exception
*/
@@ -83,6 +87,7 @@ public interface WxCpCgService {
* @param url 接口地址
* @param queryParam 请求参数
* @param withoutCorpAccessToken 请求是否忽略CorpAccessToken 默认不忽略-false
* @param req 获取token请求参数
* @return the string
* @throws WxErrorException the wx error exception
*/
@@ -93,6 +98,7 @@ public interface WxCpCgService {
*
* @param url 接口地址
* @param postData 请求body字符串
* @param req 获取token请求参数
* @return the string
* @throws WxErrorException the wx error exception
*/
@@ -110,6 +116,7 @@ public interface WxCpCgService {
* @param executor 执行器
* @param uri 请求地址
* @param data 参数
* @param req 获取token请求参数
* @return the t
* @throws WxErrorException the wx error exception
*/
@@ -156,7 +163,7 @@ public interface WxCpCgService {
/**
* 互联企业的服务类对象
*
* @return
* @return 互联企业服务对象
*/
WxCpLinkedCorpService getLinkedCorpService();
@@ -164,10 +171,11 @@ public interface WxCpCgService {
* 获取下级/下游企业小程序session
* https://developer.work.weixin.qq.com/document/path/93355
*
* @param userId
* @param sessionKey
* @return
* @throws WxErrorException
* @param userId 用户ID
* @param sessionKey 会话密钥
* @param req 请求参数
* @return 小程序session结果
* @throws WxErrorException 微信错误异常
*/
WxCpMaTransferSession getCorpTransferSession(String userId, String sessionKey, WxCpCorpGroupCorpGetTokenReq req) throws WxErrorException;
}

View File

@@ -112,6 +112,7 @@ public abstract class BaseWxCpCgServiceImpl<H, P> implements WxCpCgService, Requ
* @param url the url
* @param postData the post data
* @param withoutCorpAccessToken the without Corp access token
* @param req 获取token请求参数
* @return the string
* @throws WxErrorException the wx error exception
*/
@@ -136,6 +137,7 @@ public abstract class BaseWxCpCgServiceImpl<H, P> implements WxCpCgService, Requ
* @param uri the uri
* @param data the data
* @param withoutCorpAccessToken the without Corp access token
* @param req 获取token请求参数
* @return the t
* @throws WxErrorException the wx error exception
*/
@@ -181,6 +183,7 @@ public abstract class BaseWxCpCgServiceImpl<H, P> implements WxCpCgService, Requ
* @param executor the executor
* @param uri the uri
* @param data the data
* @param req 获取token请求参数
* @return the t
* @throws WxErrorException the wx error exception
*/
@@ -197,6 +200,7 @@ public abstract class BaseWxCpCgServiceImpl<H, P> implements WxCpCgService, Requ
* @param uri the uri
* @param data the data
* @param withoutCorpAccessToken the without Corp access token
* @param req 获取token请求参数
* @return the t
* @throws WxErrorException the wx error exception
*/

View File

@@ -15,7 +15,7 @@ public interface WxCpTpEditionService {
* 延长试用期
* <p>
* <a href='https://developer.work.weixin.qq.com/document/path/91913'>文档地址</a>
* <p/>
* </p>
* 注意:
* <ul>
* <li>一个应用可以多次延长试用但是试用总天数不能超过60天</li>

View File

@@ -20,9 +20,11 @@ public interface WxCpTpIdConvertService {
* unionid与external_userid的关联
* <a href="https://developer.work.weixin.qq.com/document/path/95900">查看文档</a>
*
* @param cropId 企业ID
* @param unionid 微信客户的unionid
* @param openid 微信客户的openid
* @param subjectType 程序或公众号的主体类型: 0表示主体名称是企业的1表示主体名称是服务商的
* @return 转换结果
* @throws WxErrorException 。
*/
WxCpTpUnionidToExternalUseridResult unionidToExternalUserid(String cropId, String unionid, String openid,
@@ -31,29 +33,33 @@ public interface WxCpTpIdConvertService {
/**
* 将企业主体下的客户标签ID转换成服务商主体下的客户标签ID
* @param corpId 企业微信 ID
* @param externalTagIdList 企业主体下的客户标签ID列表最多不超过1000个
* @return 客户标签转换结果
*
* @param corpId 企业微信 ID
* @param externalTagIdList 企业主体下的客户标签ID列表最多不超过1000个
* @return 客户标签转换结果
* @throws WxErrorException .
*/
WxCpTpTagIdListConvertResult externalTagId(String corpId, String... externalTagIdList) throws WxErrorException;
/**
* 将企业主体下的微信客服ID转换成服务商主体下的微信客服ID
* @param corpId 企业微信 ID
* @param openKfIdList 微信客服ID列表最多不超过1000个
* @return 微信客服ID转换结果
* @throws WxErrorException .
*
* @param corpId 企业微信 ID
* @param openKfIdList 微信客服ID列表最多不超过1000个
* @return 微信客服ID转换结果
* @throws WxErrorException .
*/
WxCpTpOpenKfIdConvertResult ConvertOpenKfId (String corpId, String... openKfIdList ) throws WxErrorException;
WxCpTpOpenKfIdConvertResult ConvertOpenKfId(String corpId, String... openKfIdList) throws WxErrorException;
/**
* 将应用获取的外部用户临时idtmp_external_userid转换为external_userid
* @param corpId 企业微信Id
* @param businessType 业务类型。1-会议 2-收集表
* @param userType 转换的目标用户类型。1-客户 2-企业互联 3-上下游 4-互联企业(圈子)
* @param tmpExternalUserIdList 外部用户临时id最多不超过100个
* @return 转换成功的结果列表
*
* @param corpId 企业微信Id
* @param businessType 业务类型。1-会议 2-收集表
* @param userType 转换的目标用户类型。1-客户 2-企业互联 3-上下游 4-互联企业(圈子)
* @param tmpExternalUserIdList 外部用户临时id最多不超过100个
* @return 转换成功的结果列表
* @throws WxErrorException .
*/
WxCpTpConvertTmpExternalUserIdResult convertTmpExternalUserId(String corpId, int businessType, int userType, String... tmpExternalUserIdList) throws WxErrorException;
}

View File

@@ -51,8 +51,7 @@ public interface WxCpTpOAService {
String copyTemplate(@NonNull String openTemplateId, String corpId) throws WxErrorException;
/**
* <pre>
* 获取审批申请详情
* 获取审批申请详情
*
* @param spNo 审批单编号。
* @param corpId the corp id

View File

@@ -18,7 +18,7 @@ public interface WxCpTpOrderService {
* 获取订单详情
* <p>
* <a href='https://developer.work.weixin.qq.com/document/15219#%E8%8E%B7%E5%8F%96%E8%AE%A2%E5%8D%95%E8%AF%A6%E6%83%85'>文档地址</a>
* <p/>
* </p>
*
* @param orderId 订单号
* @return the order
@@ -31,7 +31,7 @@ public interface WxCpTpOrderService {
* 获取订单列表
* <p>
* <a href='https://developer.work.weixin.qq.com/document/15219#%E8%8E%B7%E5%8F%96%E8%AE%A2%E5%8D%95%E5%88%97%E8%A1%A8'>文档地址</a>
* <p/>
* </p>
*
* @param startTime 起始时间
* @param endTime 终止时间

View File

@@ -199,7 +199,7 @@ public interface WxCpTpService {
* @return permanent code info
* @throws WxErrorException the wx error exception
* @author yuan
* @since 2020 -03-18
* @since 2020-03-18
*/
WxCpTpPermanentCodeInfo getPermanentCodeInfo(String authCode) throws WxErrorException;
@@ -227,7 +227,7 @@ public interface WxCpTpService {
* @param authType 授权类型0 正式授权, 1 测试授权。
* @return pre auth url
* @throws WxErrorException the wx error exception
* @link https ://work.weixin.qq.com/api/doc/90001/90143/90602
* @see <a href="https://work.weixin.qq.com/api/doc/90001/90143/90602">文档地址</a>
*/
String getPreAuthUrl(String redirectUri, String state, int authType) throws WxErrorException;
@@ -558,12 +558,12 @@ public interface WxCpTpService {
WxCpTpAppQrcode getAppQrcode(String suiteId, String appId, String state, Integer style, Integer resultType) throws WxErrorException ;
/**
*
* 明文corpid转换为加密corpid 为更好地保护企业与用户的数据第三方应用获取的corpid不再是明文的corpid将升级为第三方服务商级别的加密corpid。<a href="https://developer.work.weixin.qq.com/document/path/95327">文档说明</a>
* 第三方可以将已有的明文corpid转换为第三方的加密corpid。
* @param corpId
* @return
* @throws WxErrorException
*
* @param corpId 企业ID
* @return 加密的企业ID
* @throws WxErrorException 微信错误异常
*/
WxCpTpCorpId2OpenCorpId corpId2OpenCorpId(String corpId) throws WxErrorException;
@@ -655,6 +655,8 @@ public interface WxCpTpService {
/**
* 构造第三方应用oauth2链接
*
* @return OAuth2服务
*/
WxCpTpOAuth2Service getWxCpTpOAuth2Service();

View File

@@ -13,7 +13,7 @@ import java.util.List;
* </pre>
*
* @author zhangq <zhangq002@gmail.com>
* @since 2021 -02-14 16:02
* @since 2021-02-14 16:02
*/
public interface WxCpTpTagService {
/**

View File

@@ -26,7 +26,7 @@ public class WxCpTpEditionServiceImpl implements WxCpTpEditionService {
* 延长试用期
* <p>
* <a href='https://developer.work.weixin.qq.com/document/path/91913'>文档地址</a>
* <p/>
* </p>
* <ul>
* <li>一个应用可以多次延长试用但是试用总天数不能超过60天</li>
* <li>仅限时试用或试用过期状态下的应用可以延长试用期</li>

View File

@@ -30,7 +30,7 @@ public class WxCpTpOrderServiceImpl implements WxCpTpOrderService {
* 获取订单详情
* <p>
* <a href='https://developer.work.weixin.qq.com/document/15219#%E8%8E%B7%E5%8F%96%E8%AE%A2%E5%8D%95%E8%AF%A6%E6%83%85'>文档地址</a>
* <p/>
* </p>
*
* @param orderId 订单号
* @return the order
@@ -49,7 +49,7 @@ public class WxCpTpOrderServiceImpl implements WxCpTpOrderService {
* 获取订单列表
* <p>
* <a href='https://developer.work.weixin.qq.com/document/15219#%E8%8E%B7%E5%8F%96%E8%AE%A2%E5%8D%95%E5%88%97%E8%A1%A8'>文档地址</a>
* <p/>
* </p>
*
* @param startTime 起始时间
* @param endTime 终止时间

View File

@@ -25,7 +25,7 @@ import static me.chanjar.weixin.cp.constant.WxCpApiPathConsts.Tag.*;
* </pre>
*
* @author zhangq <zhangq002@gmail.com>
* @since 2021 -02-14 16:02
* @since 2021-02-14 16:02
*/
@RequiredArgsConstructor
public class WxCpTpTagServiceImpl implements WxCpTpTagService {

View File

@@ -20,7 +20,7 @@ public class XStreamTransformer {
protected static final Map<Class<?>, XStream> CLASS_2_XSTREAM_INSTANCE = configXStreamInstance();
/**
* xml -> pojo
* {@code xml -> pojo}
*
* @param <T> the type parameter
* @param clazz the clazz
@@ -58,7 +58,7 @@ public class XStreamTransformer {
}
/**
* pojo -> xml.
* {@code pojo -> xml.}
*
* @param <T> the type parameter
* @param clazz the clazz