钉钉机器人插件

Appearance

Return to top
On this page

在 pipeline 中使用

取消项目中勾选的机器人，防止重复发送消息

语法

groovy

dingtalk(
        robot: '',
        type: '',
        at: [],
        atAll: false,
        title: '',
        text: [],
        messageUrl: '',
        picUrl: '',
        singleTitle: '',
        btns: [],
        btnLayout: '',
        hideAvatar: false
)

参数说明

通用的参数

参数类型说明
robotString机器人 id
typeMsgTypeEnum消息类型
atList<String>需要 @ 的手机号码
atAllboolean是否 @ 全部

TIP

robot 参数可以在机器人配置中找到

查看详情

robot-id.jpg

MsgTypeEnum

java

public enum MsgTypeEnum {
  TEXT,

  LINK,

  MARKDOWN,

  ACTION_CARD
}

TEXT 类型的消息

参数类型说明
textList<String>发送文本消息
参数类型说明
titleString消息标题
textList<String>消息内容，如果太长只会部分展示
messageUrl（必填）String点击消息跳转的 URL
picUrlString图片 URL

WARNING

该类型的消息不支持 At 功能

MARKDOWN 类型的消息

参数类型说明
titleString首屏会话 透出的展示内容
textList<String>消息内容，支持 [受限的 markdonw](#受限的 markdonw) 语法

ACTION_CARD 类型的消息

参数类型说明
titleString首屏会话 透出的展示内容
textList<String>消息内容，支持 [受限的 markdonw](#受限的 markdonw) 语法
btnLayoutBtnLayoutEnum按钮的排列方式
hideAvatarboolean是否隐藏发消息者头像

BtnLayoutEnum

java

public enum BtnLayoutEnum {

  /**
   * horizotal：水平排列
   */
  H,

  /**
   * vertical：垂直排列
   */
  V;
}

整体跳转

参数类型说明
singleTitleString单个按钮的方案（设置此项和 singleUrl 后 btns 无效）
singleUrlString点击 singleTitle 按钮触发的 URL

独立跳转

参数类型说明
btnsList<ButtonModel>自定义按钮组

ButtonModel

java

public class ButtonModel {

  /**
   * 按钮标题
   */
  private String title;

  /**
   * 点击按钮跳转的链接
   */
  private String actionUrl;

}

默认设置

title 参数

当参数为空时，默认会使用 Jenkins 通知

ACTION_CARD 类型的消息

当 singleTitle 与 btns 都为空时，默认会创建 『更改记录』『控制台』 2 个按钮

效果展示

TEXT 消息

点击查看

text

点击查看

link

MARKDOWN 消息

点击查看

markdown

ACTION_CARD 整体跳转

点击查看

actionCard

ACTION_CARD 独立跳转

点击查看

actionCard

首屏会话

点击查看

首屏会话

其他

更多细节请参考 示例 章节