消息类型与数据格式

本文介绍了钉钉消息通知类型和数据格式。

钉钉消息通知类型

工作通知消息：是以企业工作通知会话中某个微应用的名义推送到员工的通知消息，例如生日祝福、入职提醒等。

群消息：是指可以调用接口以系统名义向群里推送群聊消息。

普通消息：是指员工个人在使用应用时，可以通过界面操作的方式往群或其他人的会话里推送消息，例如发送日志的场景。

任务类通知：是指需要发送一条任务提醒给员工，比如审批任务等。

文本消息（text）

{
    "msgtype": "text",
    "text": {
        "content": "月会通知"
    }
}

参数说明：

名称	类型	是否必填	示例值	描述
msgtype	String	是	text	消息类型。

消息样例：

图片消息

{
    "msgtype": "image",
    "image": {
        "media_id": "@lADOADmaWMzazQKA"
    }
}

参数说明：

名称	类型	是否必填	示例值	描述
msgtype	String	是	image	消息类型。

可以通过上传媒体文件接口获取。建议宽600像素 x 400像素，宽高比3 : 2。|

消息样例：

语音消息

{
    "msgtype": "voice",
    "voice": {
       "media_id": "@lADOADmaWMzazQKA",
       "duration": "10"
    }
}

参数说明：

名称	类型	是否必填	示例值	描述
msgtype	String	是	voice	消息类型。

消息样例：

文件消息

{
    "msgtype": "file",
    "file": {
       "media_id": "MEDIA_ID"
    }
}

参数说明：

名称	类型	是否必填	示例值	描述
msgtype	String	是	file	消息类型。

引用的媒体文件最大10MB。可以通过上传媒体文件接口获取。|

消息样例：

链接消息

{
    "msgtype": "link",
    "link": {
        "messageUrl": "http://s.dingtalk.com/market/dingtalk/error_code.php",
        "picUrl":"@lALOACZwe2Rk",
        "title": "测试",
        "text": "测试"
    }
}

参数说明：

名称	类型	是否必填	示例值	描述
msgtype	String	是	link	消息类型。

消息样例：

OA消息

{
     "msgtype": "oa",
     "oa": {
        "message_url": "http://dingtalk.com",
        "head": {
            "bgcolor": "FFBBBBBB",
            "text": "头部标题"
        },
        "body": {
            "title": "正文标题",
            "form": [
                {
                    "key": "姓名:",
                    "value": "张三"
                },
                {
                    "key": "年龄:",
                    "value": "20"
                },
                {
                    "key": "身高:",
                    "value": "1.8米"
                },
                {
                    "key": "体重:",
                    "value": "130斤"
                },
                {
                    "key": "学历:",
                    "value": "本科"
                },
                {
                    "key": "爱好:",
                    "value": "打球、听音乐"
                }
            ],
            "rich": {
                "num": "15.6",
                "unit": "元"
            },
            "content": "大段文本大段文本大段文本大段文本大段文本大段文本",
            "image": "@lADOADmaWMzazQKA",
            "file_count": "3",
            "author": "李四 "
        }
    }
}

参数说明：

名称	类型	是否必填	示例值	描述
msgtype	String	是	oa	消息类型。

OA消息类型为：oa。|

OA消息体参数：

名称	类型	是否必填	示例值	描述
oa.message_url	String	是	http://dingtalk.com	消息点击链接地址，当发送消息为小程序时支持小程序跳转链接。

说明

不支持部门id列表，

消息样例：

markdown消息

{
    "msgtype": "markdown",
    "markdown": {
        "title": "首屏会话透出的展示内容",
        "text": "# 这是支持markdown的文本   \n   ## 标题2    \n   * 列表1   \n  ![alt 啊](https://img.alicdn.com/tps/TB1XLjqNVXXXXc4XVXXXXXXXXXX-170-64.png)"
    }
}

markdown语法说明如下：

标题
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
 
引用
> A man who stands for nothing will fall for anything.
 
文字加粗、斜体
**bold**
*italic*
 
链接
[this is a link](http://name.com)
 
图片
![](http://name.com/pic.jpg)
 
无序列表
- item1
- item2
 
有序列表
1. item1
2. item2

换行
  \n  (建议\n前后分别加2个空格)

参数说明：

名称	类型	是否必填	示例值	描述
msgtype	String	是	markdown	消息类型，Markdown类型为：markdown。

消息样例：

卡片消息

卡片消息支持整体跳转ActionCard样式和独立跳转ActionCard样式：

整体跳转ActionCard样式，支持一个点击Action，必须传入参数 single_title和 single_url。

{
    "msgtype": "action_card",
    "action_card": {
        "title": "是透出到会话列表和通知的文案",
        "markdown": "支持markdown格式的正文内容",
        "single_title": "查看详情",
        "single_url": "https://open.dingtalk.com"
    }
}

独立跳转ActionCard样式，支持多个点击Action，必须传入参数 btn_orientation 和 btn_json_list。

{
    "msgtype": "action_card",
    "action_card": {
        "title": "是透出到会话列表和通知的文案",
        "markdown": "支持markdown格式的正文内容",
        "btn_orientation": "1",
        "btn_json_list": [
            {
                "title": "一个按钮",
                "action_url": "https://www.taobao.com"
            },
            {
                "title": "两个按钮",
                "action_url": "https://www.tmall.com"
            }
        ]
    }
}

参数说明：

名称	类型	是否必填	示例值	描述
msgtype	String	是	action_card	消息类型。

说明

0：竖直排列
1：横向排列
必须与btn_json_list同时设置。

说明

消息样例：

通过整体跳转ActionCard类型消息发出的消息样式如下：
整体跳转消息示例

通过独立跳转ActionCard类型消息发出的消息样式如下：
独立消息示例

钉钉消息通知类型#

文本消息（text）#

图片消息#

语音消息#

文件消息#

链接消息#

OA消息#

markdown消息#

卡片消息#

钉钉消息通知类型

文本消息（text）

图片消息

语音消息

文件消息

链接消息

OA消息

markdown消息

卡片消息