dingtalk

钉钉机器人消息封装——Golang

目前自定义机器人支持

  • 文本（text）
  • 链接（link）
  • markdown
  • ActionCard
    • 整体跳转
    • 独立跳转
  • FeedCard

机器人官方文档

  • 添加钉钉群：35451012，执行dingtalk_test.go测试方法可直接查看以下消息内容。

使用

创建钉钉群机器人

  1. 选择添加自定义机器人。
  2. 安全设置
    共有关键词、加签、IP白名单三种设置，需要根据情况进行选择。
    [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Cd03uXui-1609383182732)(https://i.loli.net/2020/07/05/4XqHG2dOwo8StEu.jpg)]
  3. 选择自定义关键词，这里设置的关键词在初始化机器人的时候会用到。

获取

  • go get github.com/blinkbean/dingtalk

初始化

  • // key 创建钉钉机器人需要设置的关键词，默认为`.`
func InitDingTalk(tokens []string, key string) *dingTalk

// 加签方式创建钉钉机器人
// 加签机器人 access_token和secret一一对应，在创建机器人是获取
func InitDingTalkWithSecret(tokens string, secret string) *DingTalk

  • import "github.com/blinkbean/dingtalk"

func main() {
    // 单个机器人有单位时间内消息条数的限制，如果有需要可以初始化多个token，发消息时随机发给其中一个机器人。
    var dingToken = []string{"7bd675b66646ba890046c2198257576470099e1bda0770bad7dd6684fb1e0415"}
    cli := dingtalk.InitDingTalk(dingToken, ".")
    cli.SendTextMessage("content")
}

text类型

  • 方法及可选参数
    // 方法定义
SendTextMessage(content string, opt ...atOption) error

// 可选参数
// @所有人
WithAtAll()

// @指定群成员
WithAtMobiles(mobiles []string)
  • 使用
    // at所有人
cli.SendTextMessage("content", WithAtAll())

// at指定群成员
mobiles := []string{"131********"}
cli.SendTextMessage("content", WithAtMobiles(mobiles))
  • [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-BCu3HFo8-1609383182748)(https://i.loli.net/2020/07/05/LXErbH1KiRGstQ7.jpg)]

link类型

  • 方法
    // 方法定义
SendLinkMessage(title, text, picUrl, msgUrl string) error
  • 使用
    cli.SendLinkMessage(title, text, picUrl, msgUrl)
  • [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-A6jXhdAE-1609383182751)(https://i.loli.net/2020/07/05/wDG1sMPlU7XZQfr.jpg)]

markdown类型

  • 方法及可选参数

    // 方法定义
// text：markdown格式字符串
SendMarkDownMessage(title, text string, opts ...atOption) error

// 可选参数 目前钉钉markdown格式消息不支持@（可能是钉钉的bug），所以以下可选参数暂时不生效。
// @所有人
WithAtAll()

// @指定群成员
WithAtMobiles(mobiles []string)

  • 使用

    cli.SendMarkDownMessage(title, text)

  • Markdown进阶

    // 按行写入数组，增强markdown的可读性
msg := []string{
    "### Link test",
    "---",
    "- <font color=#00ff00 size=6>红色文字</font>",
    "- 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())

  • [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-2y4k2M37-1609383182754)(https://i.loli.net/2020/07/05/7LScefCZIGnDjBV.jpg)]

  • [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-B5PYTjIm-1609383182757)(https://i.loli.net/2020/07/26/PADJ5uqmfQht2cr.jpg)]

  • 点击链接发送消息

    点击’dtmdLink1’，自动发送’dtmdValue1’并@机器人，简化输入

    // 创建有序map
dtmdOrderMap := DingMap().
    Set("dtmdOrderMap1", "dtmdValue1").
    Set("dtmdOrderMap2", "dtmdValue2").
    Set("dtmdOrderMap3", "dtmdValue3")
err := dingTalkCli.SendDTMDMessage("DTMD title", dtmdOrderMap)

  • [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-h15FF5fw-1609383182760)(https://i.loli.net/2020/11/02/1OqEr4HKZWapRgd.jpg)]

整体跳转ActionCard类型

  • 方法及可选参数
    // 方法定义
SendActionCardMessage(title, text string, opts ...actionCardOption) error

// 可选参数
// 标题
WithCardSingleTitle(title string)

// 跳转地址
WithCardSingleURL(url string)
  • 使用
    cli.SendActionSingleMessage(title, text, WithCardSingleTitle(sTitle), WithCardSingleURL(url))
  • [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-HVGqLNFi-1609383182762)(https://i.loli.net/2020/07/05/kKELHAlomndiO9I.jpg)]

独立跳转ActionCard类型

  • 方法及可选参数
    // 方法定义
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"`
}
  • 使用
    btns := []ActionCardMultiBtnModel{{
    Title:     "test1",
    ActionURL: testUrl,
    },{
    Title:     "test2",
    ActionURL: testUrl,
    },
}
cli.SendActionSingleMessage(title, text, WithCardBtns(btns))
  • [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-1uALzgDH-1609383182763)(https://i.loli.net/2020/07/05/t9GywHFSQUWCVDT.jpg)]
  • [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-OH6OzXyF-1609383182764)(https://i.loli.net/2020/07/26/pEg7hotXZnsaJPV.jpg)]

FeedCard类型

  • 方法
    // 方法定义
SendFeedCardMessage(feedCard []FeedCardLinkModel) error

// FeedCardLinkModel
type FeedCardLinkModel struct {
	Title      string `json:"title,omitempty"`
	MessageURL string `json:"messageURL,omitempty"`
	PicURL     string `json:"picURL,omitempty"`
}
  • 使用
    links := []FeedCardLinkModel{
    {
        Title:      "FeedCard1.",
        MessageURL: testUrl,
        PicURL:     testImg,
    },
    {
        Title:      "FeedCard2",
        MessageURL: testUrl,
        PicURL:     testImg,
    },
    {
        Title:      "FeedCard3",
        MessageURL: testUrl,
        PicURL:     testImg,
    },
}
cli.SendFeedCardMessage(links)
  • [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-yPI4l7Bp-1609383182765)(https://i.loli.net/2020/07/05/F5WDLqyJ4Yzfj6A.jpg)]

OutGoing

  • 消息格式

    {
    "atUsers":[
        {
            "dingtalkId":"$:LWCP_v1:$1h0bmSzcLCHncx0lCt3Bb/UVz7xv/8vh*"
        }],
    "chatbotUserId":"$:LWCP_v1:$1h0bmSzcLCHncx0lCt3Bb/UVz7x/8vh*",
    "conversationId":"cidkkCwvtlh1L0RmFuhmashi*==",
    "conversationTitle":"项目群",
    "conversationType":"2",
    "createAt":1595232438950,
    "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":1595237839030,
    "text":{
        "content":" outgoing"
    }
}

  • Usage

    func OutGoing(ctx *gin.Context){
    cli := dingtalk.InitDingTalk([]string{"***"}, ".")
    msg, _ := cli.OutGoing(ctx.Request.Body)
    // 处理content
    res := doSomeThing(msg.Text.Content)

    textMsg := dingtalk.NewTextMsg(res)
    ctx.Set("respData", textMsg)
    ctx.JSON(ctx.Writer.Status(), data)
    return 
}
# golang # 机器人
Logo
DAMO开发者矩阵

DAMO开发者矩阵，由阿里巴巴达摩院和中国互联网协会联合发起，致力于探讨最前沿的技术趋势与应用成果，搭建高质量的交流与分享平台，推动技术创新与产业应用链接，围绕“人工智能与新型计算”构建开放共享的开发者生态。

更多推荐

cover

AI高薪职位的战场：大模型、Agent、具身智能等核心岗位火热招聘中！

avatar DAMO开发者矩阵
cover

人形机器人双臂协同如何防自碰撞？核心技术原理解析|富唯智能

avatar DAMO开发者矩阵

微信机器人遇到复杂任务怎么办？个人微信二次开发中的状态管理思路

简单任务是"收一条→回一条"一问一答，复杂任务是"多轮对话 + 多步执行 + 中间状态"。用户对 Eyun 接入的机器人说"帮我订明天去北京的票"，机器人得追问"几点的？""高铁还是飞机？"，每步都有状态要记。状态管不好，机器人第二天就忘了用户昨天说到哪。复杂任务的状态管理不是一锅炖，按状态类型分三类来说。

avatar DAMO开发者矩阵