Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cocowwy/dingtalk-robot
:robot:拆箱即用的钉钉机器人，已解决20次/秒的消息上限问题，支持复杂业务场景下，根据业务标识使用指定的机器人进行消息通知
https://github.com/cocowwy/dingtalk-robot
java springboot
Last synced: 3 days ago
JSON representation
:robot:拆箱即用的钉钉机器人，已解决20次/秒的消息上限问题，支持复杂业务场景下，根据业务标识使用指定的机器人进行消息通知
- Host: GitHub
- URL: https://github.com/cocowwy/dingtalk-robot
- Owner: Cocowwy
- License: apache-2.0
- Created: 2021-12-16T01:59:34.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T03:50:33.000Z (almost 2 years ago)
- Last Synced: 2023-12-19T08:44:13.533Z (11 months ago)
- Topics: java, springboot
- Language: Java
- Homepage:
- Size: 143 KB
- Stars: 24
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# :robot:cocowwy-dingtalk-robot
## 说明
拆箱即用，以便更灵活的将钉钉机器人快速的嵌入到业务里，用来应付在复杂场景里对不同业务类型的机器人来按需调用，同时会提供一些应付更复杂的业务场景的功能
- **群机器人**
- 对钉钉群引入的机器人进行管理，可根据业务统一调度不同群的机器人发送消息
- 在上述功能的基础上，实现根据手机号@指定人员
- 在上述功能的情况下，实现消息延时发送，消息定时发送（coding...）
- **由于群机器人有1分钟20条消息的上限，实现机器人对短时间内（10s）的并发消息按顺序拼接成长消息体，解决上限问题**
- **单聊机器人**
- 对多个单聊机器人进行统一的管理，可细粒度的控制不同机器人根据手机号发送消息
- 对token进行自定义缓存时间，调用方可以无需考虑钉钉开放平台对token获取接口的限流，api会自动对token进行自定义时长的缓存
- 实现一个消息能被同一个分组内的机器人随机消费，按权重消费（coding...）
- 发送带有link链接的单聊机器人
- 白名单控制发送，以及禁用发送功能
## pom.xml：
```
cn.cocowwy
cocowwy-dingtalk-robot
1.0.7
```
## yml：
```yml
dingding:
robots:
hooks:
- label: robotA
signature: robotA的signature
webhook: robotA的webhook
- label: robotB
signature: robotB的signature
webhook: robotB的webhook
robot:
- label: robot1
agentId: robot1的agentId
appKey: robot1的appKey
appSecret: robot1的appSecret
whitelist: 1234,3456
ban: true
tokenRefresh: robot1 的 Token的缓存时长，默认110min
- label: robot2
agentId: robot2的agentId
appKey: robot2的appKey
appSecret: robot2的appSecret
whitelist: 1234,3456
ban: false
```
### 🍓参数说明：
hooks： 是webhook机器人数组，你可以塞一堆机器人来控制对每个机器人在不同群发的消息
robot 是钉钉机器人数组,你也可以设置一堆机器人来私聊（骚扰）不同的人
label： 在使用api进行发送时，指定使用的哪一个机器人或者webhook的配置
whitelist： 白名单，当白名单指定之后（用户的钉钉userid），发送对象会和白名单取并集进行发送，如果不指定白名单，则无视白名单功能
ban：是否使用禁止发送功能，默认是false，开启后，将不会进行消息的发送
### 如何使用？
注入即可使用相应的API，您只需在调用处传入你所需要使用的机器人的**label**即可实现调用
- **hooks** 群机器人需要注入**DingTalkGroupApi**来进行使用
- **robot** 单聊机器人需要注入**DingTalkRobotApi**来进行使用
### 使用Demo
```java
/**
* @author cocowwy.cn
* @create 2021-12-12-10:41
*/
@Component
public class Runner implements ApplicationRunner {
@Autowired
private DingTalkRobotApi dingTalkRobotApi;
@Autowired
private DingTalkGroupApi dingTalkGroupApi;
@Override
public void run(ApplicationArguments args) throws Exception {
// 发送群消息
dingTalkGroupApi.sendText("robot1","xxxxx" );
// 发送群消息，并且@某人
dingTalkGroupApi.sendTextAndAt("robot1", "xxxxx","Arrays.asList("需要@的手机号，不需要则传空数组")");
// 多消息自动拼接（群消息）
dingTalkGroupApi.sendFrequentlyMessage("robot1", "xxxxx", Arrays.asList("需要@的手机号，不需要则传空数组"));
// 发送机器人私聊消息
dingTalkRobotApi.sendMessageByPhonesAt("robotA", Arrays.asList("需要@的手机号，不需要则传空数组"), "xxxxx", "标题");
}
}
}
```
- DingTalkGroupApi
- getHooks 获取所有在线的群机器人label
- sendText 向指定label的群机器人发送消息
- sendTextByPhones 向指定label的群机器人发送消息，并且根据手机号@
- sendTextAndAtAll 向指定群机器人发送消息，并且@所有人
- sendFrequentlyMessage 解决群机器人1分钟的20条消息限制，该接口会在短时间内的消息自动拼接成长消息，默认缓存拼接时间为10s
- DingTalkRobotApi
- getRobots 获取单聊机器人列表
- sendMessageByPhonesAt 根据手机号向指定人发送消息
- sendMessageByUserIdsAt 根据用户id给指定人发送消息
- getToken 查询指定机器人的token
- sendLinkMessageByPhones 发送link消息
### hooks配置方式
**点击群机器人** ---> **机器人设置** ---> **往下翻** ---> **复制webhook** ---> **安全设置点击加签,将密钥复制即可**
### robot配置方式
**钉钉开放平台** ---> **点击开发者后台** ---> **应用开发** ---> **企业内部开发** ---> **点击机器人,复制需要的参数即可**
