钉钉支持扩展程序-应用市场-O2OA企业应用开发平台

钉钉支持扩展程序

V1.1 V7.2 Free

分类:插件

¥0,00

下载安装包

简介

本应用是为了支持更多个性化钉钉功能，比如图文消息，公告对接等。

如果您有什么疑问或想法，请来我们的藕粉社区交流吧！

藕粉社区

¥0.0

下载安装包

藕粉社区

TIPs

如果您有什么疑问或想法，请来我们的藕粉社区交流吧！

功能简介

安装及使用

应用图片

O2OA 钉钉支持扩展程序

本应用是为了支持更多个性化钉钉功能，比如图文消息，公告对接等。

前提条件是用户在使用钉钉并且O2OA已经集成了钉钉，具体集成方式参考 https://www.o2oa.net/cms/mobileoa/194.html

钉钉消息推送

在O2OA集成钉钉的文章中已经提到过，O2OA的消息推送给钉钉需要在 dingding.json 配置文件中开启消息参数 messageEnable ，然后默认O2OA内置有钉钉消息推送功能就会把消息推送给钉钉，但是默认消息是普通文本消息，工作消息也是一个打开链接，无法做更多扩展。

关于内置消息的各种类型的消息发送，还有发送消息的处理器可以参考O2OA消息处理器的文章，《o2server 消息和消息处理器使用》

本应用的消息接口，可扩展更多形式的消息。

平替内置钉钉消息推送

就是用本应用内的消息接口来替换O2OA内置的钉钉消息发送器。

所以只要按照前面提到的O2OA消息处理器的文章《o2server 消息和消息处理器使用》内说明的，找到O2OA服务器的配置文件 messages.json ，把原来里面默认的钉钉消息处理器关闭，启用restful的处理器，比如待办消息类型下的消息处理器：

"task_create": {
    "consumers": [
      {
        "type": "ws",
        "enable": true,
        "loader": "",
        "filter": ""
      },
      {
        "type": "pmsinner",
        "enable": true,
        "loader": "",
        "filter": ""
      },
      {
        "type": "dingding",
        "enable":  false, //这里改成false，关闭默认钉钉消息处理器
        "loader": "",
        "filter": ""
      },
      // restful 消息处理器配置如下
     {
        "url": "http://127.0.0.1:20020/x_app_dingding_support_assemble_control/jaxrs/o2msg/receive", //这里注意应用端口，默认是80或者20020
        "method": "post", // 这里是post请求
        "type": "restful",
        "enable": true, // 这里是启用restful处理器
        "loader": "",
        "filter": ""
      },
    ],
    "description": "创建待办"
  },

将需要发送钉钉消息的各种O2OA消息类型都按照上面这样的方式进行处理器的配置就可以使用本应用的消息处理器进行钉钉消息的推送。

信息发布模版消息

目前本应用针对信息发布支持3种特殊的钉钉消息的模版，分别是链接消息、oa消息、卡片消息样式如下：

链接消息：

oa消息：

卡片消息：

如何使用： O2OA的消息处理器都带有一个脚本加载器，就是上面配置里面的 loader 字段，这个字段可以配置一个脚本，处理消息的具体内容。具体使用方式可以参考上面提到的《o2server 消息和消息处理器使用》文章中 加载器 这段内容。

加载器的作用是处理消息体中信息发布文档数据对象的具体内容，当然也可以不使用加载器，在信息发布中的其他事件中处理好文档数据对象的具体内容，文档数据对象中要包含具体消息模版需要的字段内容。具体需要的内容根据模版不同有如下要求：

链接消息

{
   "id":"文档id",
   "summary":"文档描述信息",
   "title":"文档标题",
   "appId":"...",
   "appName":"...",
   "categoryId":"...",
   "categoryName":"...",
   ...
   "tempType": "link", //表示链接消息
   "tempTitle": "这里是链接消息的标题", 
   "tempText": "这里是链接消息的内容描述", 
   "tempCmsPicId": "这里是链接消息的图片id，图片必须是已经上传到信息发布中的文件。tempCmsPicId和tempMediaid只需要一个就够了", 
   "tempMediaid": "已经上传图片到钉钉，钉钉返回的mediaId。上传图片到钉钉，本应用提供了专门的接口。tempCmsPicId和tempMediaid只需要一个就够了",
   "tempUrl": "默认不需要这个字段，如果有特殊的地址需要打开，可以添加这个字段，只支持o2oa内部html地址"
}

oa消息

{
   "id":"文档id",
   "summary":"文档描述信息",
   "title":"文档标题",
   "appId":"...",
   "appName":"...",
   "categoryId":"...",
   "categoryName":"...",
   ...
   "tempType": "oa", //表示oa消息
   "tempTitle": "这里是oa消息的标题", 
   "tempText": "这里是oa消息的内容描述", 
   "tempCmsPicId": "这里是oa消息的图片id，图片必须是已经上传到信息发布中的文件。tempCmsPicId和tempMediaid只需要一个就够了", 
   "tempMediaid": "已经上传图片到钉钉，钉钉返回的mediaId。上传图片到钉钉，本应用提供了专门的接口。tempCmsPicId和tempMediaid只需要一个就够了",
   "tempUrl": "默认不需要这个字段，如果有特殊的地址需要打开，可以添加这个字段，只支持o2oa内部html地址"
}

卡片消息

{
   "id":"文档id",
   "summary":"文档描述信息",
   "title":"文档标题",
   "appId":"...",
   "appName":"...",
   "categoryId":"...",
   "categoryName":"...",
   ...
   "tempType": "card", //表示卡片消息
   "tempTitle": "这里是卡片消息的标题", 
   "tempText": "这里是卡片消息的内容描述", 
   "tempCardImageUrl": "如果卡片消息需要上图示那样有图片展现，需要添加这个字段，里面添加在线的图片url地址，匿名可访问的图片地址。",
   "tempCardSingleTitle": "查看详情"
}

直接调用接口发送钉钉消息

本应用提供了两个发送钉钉消息的接口，一个是工作通知消息，一个是普通消息。两者消息类型都是相同的，分别有消息类型： text , image, voice ,file, link, oa, markdown, action_card 。

媒体文件上传到钉钉的接口

url: /x_app_dingding_support_assemble_control/jaxrs/dingdingsupport/media/upload/{type} method: POST url中的type：

image：图片，图片最大1MB。支持上传jpg、gif、png、bmp格式。
voice：语音，语音文件最大2MB。支持上传amr、mp3、wav格式。
video：视频，视频最大10MB。支持上传mp4格式。
file：普通文件，最大10MB。支持上传doc、docx、xls、xlsx、ppt、pptx、zip、pdf、rar格式。

上传成功后返回的id，就是钉钉的mediaId，消息发送的需要用到这个值。

工作通知消息接口

url: /x_app_dingding_support_assemble_control/jaxrs/dingdingsupport/msg/corpconversation/send method: POST 各种消息类型需要提交的字段不同，参考文档下面的 消息类型提交内容样例 的样例说明

orgList：需要发送消息给哪些部门， orgList和personList两个至少需要一个有值
personList：需要发送消息给哪些人员， orgList和personList两个至少需要一个有值
toAllUser： true | false ，如果是true，全员发送，orgList和personList无效。（谨慎选择）

发送普通消息

url: /x_app_dingding_support_assemble_control/jaxrs/dingdingsupport/msg/normal/send method: POST 各种消息类型需要提交的字段不同，参考文档下面的 消息类型提交内容样例 的样例说明

cid：这个是需要前端调用钉钉的jsapi 选择聊天会话返回的cid。具体参考：https://open.dingtalk.com/document/orgapp-client/obtain-session-information-h5

消息类型提交内容样例

发送文字消息，请求的body体需要提供：

{
    "msgtype": "text",
    "text": "这里是消息内容"
}

发送图片消息，请求的body体需要提供：

{
    "msgtype": "image",
    "mediaid": "图片文件id，来自上面提到的媒体文件上传到钉钉的接口的返回值"
}

发送语音消息，请求的body体需要提供：

{
    "msgtype": "voice",
    "mediaid": "语音文件id，来自上面提到的媒体文件上传到钉钉的接口的返回值",
    "duration": 10
}

发送文件消息，请求的body体需要提供：

{
    "msgtype": "file",
    "mediaid": "文件id，来自上面提到的媒体文件上传到钉钉的接口的返回值"
}

发送链接消息，请求的body体需要提供：

{
    "msgtype": "link",
    "mediaid": "图片id，来自上面提到的媒体文件上传到钉钉的接口的返回值",
    "title": "标题",
    "text": "描述",
    "messageUrl": "打开消息的url",
}

发送oa消息，请求的body体需要提供：

{
    "msgtype": "oa",
    "title": "标题",
    "text": "描述",
    "messageUrl": "打开消息的url"
}

发送markdown消息，请求的body体需要提供：

{
    "msgtype": "markdown",
    "title": "标题",
    "text": "这里填markdown格式的内容，可以生成富文本内容"
}

发送卡片消息，请求的body体需要提供：

{
    "msgtype": "action_card",
    "title": "标题",
    "text": "这里填markdown格式的内容，可以生成富文本内容",
    "messageUrl": "打开消息的url",
    "cardSingleTitle": "查看详情"
}

钉钉公告

创建钉钉公告

url: /x_app_dingding_support_assemble_control/jaxrs/dingdingsupport/blackboard/create method: POST 具体参数说明如下图：

钉钉公告列表

查询当前用户能看到的公告列表，最多10条. url: /x_app_dingding_support_assemble_control/jaxrs/dingdingsupport/blackboard/list/top method: GET 具体参数说明如下图：

钉钉公告详情

url: /x_app_dingding_support_assemble_control/ jaxrs/dingdingsupport/blackboard/{id} method: GET 具体参数说明如下图：

钉钉公告更新

url: /x_app_dingding_support_assemble_control/ jaxrs/dingdingsupport/blackboard/update/{blackboardId} method: POST 具体参数说明如下图：

钉钉公告删除

url: /x_app_dingding_support_assemble_control/ jaxrs/dingdingsupport/blackboard/{id} method: DELETE 具体参数说明如下图：