Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blinkbean/dingtalk
golang钉钉机器人客户端。支持文本、链接、Markdown、ActionCard、FeedCard类型消息的发送，Outgoing机器人消息的接收。通过钉钉机器人接口和不同消息的封装，达到简单快速发送不同类型消息的目的。
https://github.com/blinkbean/dingtalk
dingding golang
Last synced: about 2 months ago
JSON representation
golang钉钉机器人客户端。支持文本、链接、Markdown、ActionCard、FeedCard类型消息的发送，Outgoing机器人消息的接收。通过钉钉机器人接口和不同消息的封装，达到简单快速发送不同类型消息的目的。
- Host: GitHub
- URL: https://github.com/blinkbean/dingtalk
- Owner: blinkbean
- License: mit
- Created: 2020-07-05T01:52:38.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-25T13:07:43.000Z (2 months ago)
- Last Synced: 2024-07-25T15:03:21.759Z (2 months ago)
- Topics: dingding, golang
- Language: Go
- Homepage:
- Size: 260 KB
- Stars: 228
- Watchers: 7
- Forks: 56
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dingtalk
[](https://goreportcard.com/report/github.com/blinkbean/dingtalk)
[](https://github.com/blinkbean/dingtalk)
[](https://github.com/blinkbean/dingtalk)
[](https://github.com/blinkbean/dingtalk/releases)
[](https://github.com/blinkbean/dingtalk/pulls)
[](https://github.com/blinkbean/dingtalk/pulls?q=is%3Apr+is%3Aclosed)
[](https://github.com/blinkbean/dingtalk/issues)
[](https://github.com/blinkbean/dingtalk/issues?q=is%3Aissue+is%3Aclosed)
## 钉钉机器人消息封装——Golang
目前自定义机器人支持
- [OutGoing](#outgoing) `新`
- [文本（Text）](#text类型)
- [链接（Link）](#link类型)
- [Markdown](#markdown类型)
- ActionCard
- [整体跳转](#整体跳转actioncard类型)
- [独立跳转](#独立跳转actioncard类型)
- [FeedCard](#feedcard类型)
- 添加钉钉群：**35451012**，执行dingtalk_test.go测试方法可直接查看以下消息内容。
[机器人官方文档](https://ding-doc.dingtalk.com/doc#/serverapi2/qf2nxq)
## 使用
### 创建钉钉群机器人
1. 选择添加`自定义`机器人。
2. 安全设置
共有关键词、加签、IP白名单三种设置，需要根据情况进行选择。
3. 选择`自定义关键词`，这里设置的关键词在初始化机器人的时候会用到。
### 获取
- ```go
go get github.com/blinkbean/dingtalk
```
### 初始化
- ```go
// key 创建钉钉机器人需要设置的关键词，默认为`.`
func InitDingTalk(tokens []string, key string) *dingTalk
// 加签方式创建钉钉机器人
// 加签机器人 access_token和secret一一对应，在创建机器人是获取
func InitDingTalkWithSecret(tokens string, secret string) *DingTalk
```
- ```go
import "github.com/blinkbean/dingtalk"
func main() {
// 单个机器人有单位时间内消息条数的限制，如果有需要可以初始化多个token，发消息时随机发给其中一个机器人。
var dingToken = []string{"7bd675b66646ba890046c2198257576470099e1bda0770bad7dd6684fb1e0415"}
cli := dingtalk.InitDingTalk(dingToken, ".")
cli.SendTextMessage("content")
}
```
### OutGoing
- 钉钉OutGoing机器人原理
> 给钉钉机器人绑定一个HTTP类型的POST接口，通过@群机器人，将消息发送到指定外部服务，还可以将外部服务的响应结果返回到群组。
- 配置步骤
1. 创建钉钉群机器人时选中 `是否开启Outgoing机制`。
2. 配置POST地址，外网是可访问的接口地址，如：`http://robot.blinkbean.com/outgoing` 。
3. 当前未做Token相关逻辑，填写内容不影响测试和使用。
- 钉钉发送的消息格式
```json
{
"atUsers":[
{
"dingtalkId":"$:LWCP_v1:$1h0bmSzcLCHncx0lCt3Bb/UVz7xv/8vh*"
}],
"chatbotUserId":"$:LWCP_v1:$1hbmLCHncx0lCt3Bb/UVz7x/8vh*",
"conversationId":"cidkkCwvtlh1L0RmFuhmashi*==",
"conversationTitle":"Blinkbean",
"conversationType":"2",
"createAt":1295212438950,
"isAdmin":false,
"isInAtList":true,
"msgId":"msgm/bJkKjTupFM7ZoRF/eKR*==",
"msgtype":"text",
"sceneGroupCode":"project",
"senderId":"$:LWCP_v1:$x4wFOct/DGctv96o4IxxB*==",
"senderNick":"blinkbean",
"sessionWebhook":"https://oapi.dingtalk.com/robot/sendBySession?session=6d69b333f243db32d42c11sda9de620*",
"sessionWebhookExpiredTime":1595212438350,
"text":{
"content":" hello"
}
}
```
- 方法及可选参数
> 通过命令注册的方式，简化新命令增加操作，方便命令及其绑定方法的管理。
```go
//接口方法
type ExecFunc func(args []string) []byte
// 注册方法
func RegisterCommand(name string, execFunc ExecFunc, arity int, isAdmin bool) {
cmdTable[name] = &command{
executor: execFunc,
arity: arity,
isAdmin: isAdmin,
}
}
// Handler
type OutGoingHandler struct{}
```
- 使用
```go
// 自定义方法
outgoingFunc := func(args []string) []byte {
// do what you want to
return NewTextMsg("hello").Marshaler()
}
// 自定义方法注册到handler
RegisterCommand("hello", outgoingFunc, 2, true)
// 启动http服务
http.Handle("/outgoing", &OutGoingHandler{})
_ = http.ListenAndServe(":8000", nil)
```
- 本地测试
1. 执行dingtalk_test.go TestOutGoing 方法启动http服务
2. 执行以下curl命令（只保留了部分参数）
```shell script
curl --location --request POST '127.0.0.1:8000/outgoing' \
--header 'Content-type: application/json' \
--data-raw ' {
"isAdmin":true,
"msgtype":"text",
"text":{
"content":"hello"
}
}'
```
3. 获取返回结果
```json
{
"msgtype": "text",
"text": {
"content": "hello"
},
"at": {}
}
```
- 
### Text类型
- 方法及可选参数
```go
// 方法定义
SendTextMessage(content string, opt ...atOption) error
// 可选参数
// @所有人
WithAtAll()
// @指定群成员
WithAtMobiles(mobiles []string)
```
- 使用
```go
// at所有人
cli.SendTextMessage("content", WithAtAll())
// at指定群成员
mobiles := []string{"131********"}
cli.SendTextMessage("content", WithAtMobiles(mobiles))
```
- 
### Link类型
- 方法
```go
// 方法定义
SendLinkMessage(title, text, picUrl, msgUrl string) error
```
- 使用
```go
cli.SendLinkMessage(title, text, picUrl, msgUrl)
```
- 
### Markdown类型
- 方法及可选参数
```go
// 方法定义
// text：markdown格式字符串
SendMarkDownMessage(title, text string, opts ...atOption) error
// 可选参数 目前钉钉markdown格式消息不支持@（可能是钉钉的bug），所以以下可选参数暂时不生效。
// @所有人
WithAtAll()
// @指定群成员
WithAtMobiles(mobiles []string)
```
- 使用
```go
cli.SendMarkDownMessage(title, text)
```
- Markdown进阶
```go
// 按行写入数组，增强markdown的可读性
msg := []string{
"### Link test",
"---",
"- 红色文字",
"- content2",
}
cli.SendMarkDownMessageBySlice("Markdown title", msg, WithAtAll())
// 字体及颜色
dm := DingMap()
dm.Set("颜色测试", H2)
dm.Set("失败：$$ 同行不同色 $$", RED) // 双$分隔
dm.Set("---", N)
dm.Set("金色", GOLD)
dm.Set("成功", GREEN)
dm.Set("警告", BLUE)
dm.Set("普通文字", N)
cli.SendMarkDownMessageBySlice("color test", dm.Slice())
```
- 
- 
- 点击DTMD链接发送消息
点击'dtmdLink1'，自动发送'dtmdValue1'并@机器人，简化输入
```go
// 创建有序map
dtmdOrderMap := DingMap().
Set("dtmdOrderMap1", "dtmdValue1").
Set("dtmdOrderMap2", "dtmdValue2").
Set("dtmdOrderMap3", "dtmdValue3")
err := dingTalkCli.SendDTMDMessage("DTMD title", dtmdOrderMap)
```
- 
### 整体跳转ActionCard类型
- 方法及可选参数
```go
// 方法定义
SendActionCardMessage(title, text string, opts ...actionCardOption) error
// 可选参数
// 标题
WithCardSingleTitle(title string)
// 跳转地址
WithCardSingleURL(url string)
```
- 使用
```go
cli.SendActionSingleMessage(title, text, WithCardSingleTitle(sTitle), WithCardSingleURL(url))
```
- 
### 独立跳转ActionCard类型
- 方法及可选参数
```go
// 方法定义
SendActionCardMessage(title, text string, opts ...actionCardOption) error
// 可选参数
// 按钮排列方向，默认水平
WithCardBtnVertical()
// 跳转按钮
WithCardBtns(btns []ActionCardMultiBtnModel)
// ActionCardMultiBtnModel
type ActionCardMultiBtnModel struct {
Title string `json:"title,omitempty"`
ActionURL string `json:"actionURL,omitempty"`
}
```
- 使用
```go
btns := []ActionCardMultiBtnModel{{
Title: "test1",
ActionURL: testUrl,
},{
Title: "test2",
ActionURL: testUrl,
},
}
cli.SendActionSingleMessage(title, text, WithCardBtns(btns))
```
- 
- 
### FeedCard类型
- 方法
```go
// 方法定义
SendFeedCardMessage(feedCard []FeedCardLinkModel) error
// FeedCardLinkModel
type FeedCardLinkModel struct {
Title string `json:"title,omitempty"`
MessageURL string `json:"messageURL,omitempty"`
PicURL string `json:"picURL,omitempty"`
}
```
- 使用
```go
links := []FeedCardLinkModel{
{
Title: "FeedCard1.",
MessageURL: testUrl,
PicURL: testImg,
},
{
Title: "FeedCard2",
MessageURL: testUrl,
PicURL: testImg,
},
{
Title: "FeedCard3",
MessageURL: testUrl,
PicURL: testImg,
},
}
cli.SendFeedCardMessage(links)
```
- 