钉钉开发文档

消息类型与数据格式

更新时间: 2019-6-3

文本消息

{
    "msgtype": "text",
    "text": {
        "content": "张三的请假申请"
    }
}

参数说明

参数 参数类型 必须 说明
msgtype String 消息类型,此时固定为:text
content String 消息内容

消息样例

图片消息

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

参数说明

参数 参数类型 必须 说明
msgtype String 消息类型,此时固定为:image
media_id String 媒体文件id,可以通过媒体文件接口上传图片获取。建议宽600像素 x 400像素,宽高比3 : 2

消息样例

语音消息

{
    "msgtype": "voice",
    "voice": {
       "media_id": "MEDIA_ID",
       "duration": "10"
    }
}

参数说明

参数 参数类型 必须 说明
msgtype String 消息类型,此时固定为:voice
media_id String 媒体文件id。2MB,播放长度不超过60s,AMR格式
duration String 正整数,小于60,表示音频时长

消息样例

文件消息

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

参数说明

参数 参数类型 必须 说明
msgtype String 消息类型,此时固定为:file
media_id String 媒体文件id。引用的媒体文件最大10MB

消息样例

链接消息

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

参数说明

参数 参数类型 必须 说明
msgtype String 消息类型,此时固定为:link

消息体参数说明

参数 参数类型 必须 说明
link.messageUrl String 消息点击链接地址,当发送消息为小程序时支持小程序跳转链接
link.picUrl String 图片地址
link.title String 消息标题
link.text String 消息描述

消息样例

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.message_url String 消息点击链接地址,当发送消息为小程序时支持小程序跳转链接
oa.pc_message_url String PC端点击消息时跳转到的地址
oa.head String 消息头部内容
oa.head.bgcolor String 消息头部的背景颜色。长度限制为8个英文字符,其中前2为表示透明度,后6位表示颜色值。不要添加0x
oa.head.text String 消息的头部标题 (向普通会话发送时有效,向企业会话发送时会被替换为微应用的名字),长度限制为最多10个字符
oa.body Array[JSON Object] 消息体
oa.body.title String 消息体的标题
oa.body.form Array[JSON Object] 消息体的表单,最多显示6个,超过会被隐藏
oa.body.form.key String 消息体的关键字
oa.body.form.value String 消息体的关键字对应的值
oa.body.rich JSON Object 单行富文本信息
oa.body.rich.num String 单行富文本信息的数目
oa.body.rich.unit String 单行富文本信息的单位
oa.body.content String 消息体的内容,最多显示3行
oa.body.image String 消息体中的图片,支持图片资源
oa.body.file_count String 自定义的附件数目。此数字仅供显示,钉钉不作验证
oa.body.author String 自定义的作者名字

消息样例


markdown消息

{
    "msgtype": "markdown",
    "markdown": {
        "title": "首屏会话透出的展示内容",
        "text": "# 这是支持markdown的文本 \n## 标题2  \n* 列表1 \n![alt 啊](https://gw.alipayobjects.com/zos/skylark-tools/public/files/b424a1af2f0766f39d4a7df52ebe0083.png)"
    }
}

说明:目前只支持md语法的子集,具体支持的元素如下:

标题
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
 
引用
> 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前后都加空格)

参数说明

参数 参数类型 必须 说明
msgtype String 消息类型,此时固定为:markdown
title String 首屏会话透出的展示内容
text String markdown格式的消息

消息样例

卡片消息

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

  • 整体跳转ActionCard样式,支持一个点击Action,需要传入参数 single_title和 single_url;

  • 独立跳转ActionCard样式,支持多个点击Action,需要传入参数 btn_orientation 和 btn_json_list;

整体跳转ActionCard样式参数示例:

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

独立跳转ActionCard样式参数示例:

{
    "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"
            }
        ]
    }
}

消息体参数说明

参数 参数类型 必须 说明
action_card.title String 透出到会话列表和通知的文案
action_card.markdown String 消息内容,支持markdown,语法参考标准markdown语法。
action_card.single_title String 使用整体跳转ActionCard样式时的标题,必须与single_url同时设置
action_card.single_url String 消息点击链接地址,当发送消息为小程序时支持小程序跳转链接
action_card.btn_orientation String 使用独立跳转ActionCard样式时的按钮排列方式,竖直排列(0),横向排列(1);必须与btn_json_list同时设置
action_card.btn_json_list JSONArray 使用独立跳转ActionCard样式时的按钮列表;必须与btn_orientation同时设置
action_card.btn_json_list.title String 使用独立跳转ActionCard样式时的按钮的标题
action_card.btn_json_list.action_url String 消息点击链接地址,当发送消息为小程序时支持小程序跳转链接

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

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

以上内容是否对您有帮助:
在文档使用中是否遇到以下问题(多选):
  • 内容错误
  • 更新不及时
  • 链接错误
  • 缺少代码/图片示例
  • 太简单/步骤待完善
手机号
更多建议
提交成功,感谢您的反馈!