文档中心 > 服务端开发文档

消息类型及数据格式

更新时间:2017/11/23 访问次数:52990

text消息

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

参数说明

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

text消息展现

textmes

image消息

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

参数说明

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

img消息展现

imgmes

voice消息

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

参数说明

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

voice消息展现

voicemes

file消息

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

参数说明

参数 参数类型 必须 说明
msgtype String 消息类型,此时固定为:file
media_id String 媒体文件id,可以调用上传媒体文件接口获取。10MB

file消息展现

filemes

link消息

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

参数说明

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

link消息体格式

参数 参数类型 必须 说明
link.messageUrl String 消息点击链接地址
link.picUrl String 图片媒体文件id,可以调用上传媒体文件接口获取
link.title String 消息标题
link.text String 消息描述

link消息展现

linkmes

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.message_url String 客户端点击消息时跳转到的H5地址
oa.pc_message_url String PC端点击消息时跳转到的H5地址
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 消息体中的图片media_id
oa.body.file_count String 自定义的附件数目。此数字仅供显示,钉钉不作验证
oa.body.author String 自定义的作者名字

OA消息展现

oames

markdown消息

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

参数说明

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

Markdown消息展现

markdwon

ActionCard消息

ActionCard消息支持整体跳转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消息体格式

参数 参数类型 必须 说明
action_card.title String 透出到会话列表和通知的文案
action_card.markdown String 消息内容,支持markdown,语法参考标准markdown语法。图片举例:![alt text](mediaId)
action_card.single_title String 使用整体跳转ActionCard样式时的标题,必须与single_url同时设置
action_card.single_url String 使用整体跳转ActionCard样式时的链接url,必须与single_title同时设置
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样式时的按钮的链接url

ActionCard消息展现

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

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

消息展现示例

imgdemo

消息链接能在PC端打开

在消息文本中可以有URL链接,如果想控制在PC客户端点击链接时,能在PC客户端打开页面而不是外跳到浏览器,可以使用下面的方式:
dingtalk://dingtalkclient/page/link?url=http%3A%2F%2Fwww.dingtalk.com&pc_slide=true
其中,url参数代表要打开的链接,必须要做URLencode;
pc_slide参数,如果为true代表在PC客户端打开,为false或者不写代表用浏览器打开

FAQ

关于此文档暂时还没有FAQ
返回
顶部