路由到钉钉 - 事件总线EventBridge

您可以通过事件规则过滤事件，将事件路由到钉钉。本文以自定义事件为例介绍将事件路由到钉钉的前提条件、操作步骤和结果验证。

前提条件

开通事件总线EventBridge
下载钉钉客户端
添加自定义机器人

注意添加机器人时安全设置须选择加签。

背景信息

钉钉机器人支持接收的消息类型和结果样式如下所示：

text消息
link消息
markdown消息
整体跳转actionCard类型
独立跳转actionCard类型
feedCard类型

步骤一：创建自定义总线

登录事件总线EventBridge控制台。
在左侧导航栏，单击自定义总线。
在顶部菜单栏，选择地域。
在自定义总线页面，单击创建自定义总线。
在创建自定义总线面板的名称文本框输入自定义总线的名称，在描述文本框输入自定义总线的描述，然后单击确定。

步骤二：创建事件规则

注意目标服务和事件规则必须处于同一地域。

登录事件总线EventBridge控制台。
在左侧导航栏，单击自定义总线。
在顶部菜单栏，选择地域。
在自定义总线页面，找到目标总线，在其右侧操作列单击规则管理。
在规则管理页面，单击创建规则。

在创建规则页面，完成以下操作。

在配置基本信息配置向导页面，在名称文本框输入规则名称，在描述文本框输入规则的描述，然后单击下一步。
在配置事件模式配置向导页面，事件模式类型选择自定义事件模式，在事件模式内容代码框输入事件模式，然后单击下一步。
更多信息，请参见事件模式。

在配置事件目标配置向导页面，配置以下事件目标参数，然后单击创建。

说明 1个事件规则最多可以添加5个目标。

服务类型：单击钉钉。
地址：输入钉钉机器人的Webhook地址。
密钥：输入钉钉机器人密钥。

推送内容：选择模板。通过自定义变量和模板，将事件按照模板的示例输出。

钉钉机器人规定了其接收的消息类型和数据格式，以下为常用消息类型的变量和模板示例：

text类型

变量示例：

{
  "content": "$.data.content"
}

模板示例：

{
    "msgtype":"text",
    "text":{
        "content":"${content}@1760514XXXX"
    },
    "at":{
        "atMobiles":[
            "1760514XXXX",
            "1898325XXXX"
        ],
        "isAtAll":false
    }
}


参数	类型	是否必选	说明
msgtype	String	是	消息类型。
text	Object	是	text类型的事件内容。
content	String	是	消息内容。
at	Object	是	at（@）参数内容。
atMobiles	Array	否	被at（@）的人的手机号码。说明手机号码必须绑定钉钉账号。
isAtAll	Boolean	否	是否at（@）所有人。说明当isAtAll设置为true，钉钉接收事件消息at所有人，此时content中at某个群成员会失效。

link类型

变量示例：

{
  "name": "$.data.name"
}

模板示例：

{
    "msgtype":"link",
    "link":{
        "text":"这个即将发布的新版本，创始人${name}称它为红树林。而在此之前，每当面临重大升级，产品经理们都会取一个应景的代号，这一次，为什么是红树林？",
        "title":"时代的火车向前开",
        "picUrl":"",
        "messageUrl":"www.example.com"
    }
}


参数	类型	是否必选	说明
msgtype	String	是	消息类型。
link	Object	是	link类型的事件内容。
text	String	是	消息内容。说明如果消息内容太长，钉钉窗口中只会显示部分内容。
title	String	是	消息标题。
picUrl	String	否	图片URL。
messageUrl	String	是	消息URL。

markdown类型

变量示例：

{
    "time":"$.time",
    "content":"$.data.content"
}

模板示例：

{
    "msgtype":"markdown",
    "markdown":{
        "title":"杭州天气",
        "text":"#### 杭州天气 @1760514XXXX \n> ${content}\n> ![screenshot](img.example.com/example.png)\n> ###### ${time}发布 [天气](www.example.com) \n"
    },
    "at":{
        "atMobiles":[
            "1760514XXXX"
        ],
        "isAtAll":false
    }
}


参数	类型	是否必选	说明
msgtype	String	是	消息类型。
markdown	Object	是	markdown类型的事件内容。
title	String	是	消息标题。
text	String	是	消息内容。
at	Object	是	at（@）参数内容。
atMobiles	Array	否	被at（@）的人的手机号码。
isAtAll	Boolean	否	是否at（@）所有人。说明当isAtAll设置为true，钉钉接收事件消息at所有人，此时content中at某个群成员会失效。

整体跳转actionCard类型

变量示例：

{
    "content":"$.data.content"
}

模板示例：

{
    "msgtype":"actionCard",
    "actionCard":{
        "title":"乔布斯20年前想打造一间苹果咖啡厅，而它正是Apple Store的前身",
        "text":"![screenshot](img.example.com/example.png) \n ### ${content} \n Apple Store的设计正从原来满满的科技感走向生活化，而其生活化的走向其实可以追溯到20年前苹果一个建立咖啡馆的计划",
        "btnOrientation":"0",
        "singleTitle":"阅读全文",
        "singleURL":"www.example.com"
    }
}


参数	类型	是否必选	说明
msgtype	String	是	消息类型。
actionCard	Object	是	actionCard类型的事件内容。
title	String	是	消息预览框标题。
text	String	是	消息内容。
btnOrientation	String	否	按钮方向。取值说明如下： 0：垂直排列。 1：横向排列。
singleTitle	String	是	单个按钮的标题。
singleURL	String	是	单击singleTitle触发的URL。

独立跳转actionCard类型

变量示例：

{
    "content":"$.data.content"
}

模板示例：

{
    "msgtype":"actionCard",
    "actionCard":{
        "title":"乔布斯20年前想打造一间苹果咖啡厅，而它正是Apple Store的前身",
        "text":"![screenshot](img.example.com/example.png) \n ### ${content} \n Apple Store 的设计正从原来满满的科技感走向生活化，而其生活化的走向其实可以追溯到20年前苹果一个建立咖啡馆的计划",
        "btnOrientation":"0",
        "btns":[
            {
                "title":"内容不错",
                "actionURL":"www.example1.com"
            },
            {
                "title":"不感兴趣",
                "actionURL":"www.example2.com"
            }
        ]
    }
}


参数	类型	是否必选	说明
msgtype	String	是	消息类型。
actionCard	Object	是	actionCard类型的事件内容。
title	String	是	消息预览框标题。
text	String	是	消息内容。
btnOrientation	String	否	按钮方向。取值说明如下： 0：垂直排列。 1：横向排列。
btns	Array	是	按钮。
title	String	是	按钮的标题。
actionURL	String	是	单击按钮触发的URL。

feedCard类型

变量示例：

{
    "content":"$.data.content"
}

模板示例：

{
    "msgtype":"feedCard",
    "feedCard":{
        "links":[
            {
                "title":"${content}",
                "messageURL":"www.example1.com",
                "picURL":"img.example.com/example1.png"
            },
            {
                "title":"时代的火车向前开",
                "messageURL":"www.example2.com",
                "picURL":"img.example.com/example2.png"
            }
        ]
    }
}


参数	类型	是否必选	说明
msgtype	String	是	消息类型。
feedCard	Object	是	feedCard类型的事件内容。
links	Array	否	feedCard涉及的链接。
title	String	是	消息标题。
messageURL	String	是	消息URL。
picURL	String	是	图片URL。

更多信息，请参见事件内容转换。

步骤三：发布事件

登录事件总线EventBridge控制台。
在左侧导航栏，单击自定义总线。
在顶部菜单栏，选择地域。
在自定义总线页面，找到目标总线，在其右侧操作列单击发布事件。

说明仅自定义总线支持通过控制台发布事件。
在发布事件面板，输入事件内容，然后单击确定。
事件包含的参数规范，请参见事件概述。

结果验证

您可以在钉钉客户端查看钉钉机器人推送的消息。