1. 约定、限制及假设

Jira 已安装 DingTalk for Jira插件，并已完成移动端配置、用户绑定配置。注意：调用接口后若发送的消息相同一天只能发一次。


2. 接口文档

(1) 功能描述

根据调用方传入的参数，给对应的钉钉用户发送消息通知。

(2) 调用说明

请求类型

POST

请求地址

{jira_base_url}/rest/dingding-jira/2/message/sendMessage

媒体类型

application/json

请求头

noticeToken: xxxxxx

Required.

noticeToken 是其他插件或第三方服务在调用本 API 时必需提供的安全令牌。具体请查阅下文。

Auth

匿名接口无需 Auth。通过 headers 里面传过来的 noticeToken 判断调用是否合法。

Body

以 JSON 格式传输 body。


{     

"userKey":["JIRAUSER10100", "JIRAUSER19625"],    

 "mode":"0",    

 "title":"XXX要过期",     

"content":"XXX要过期了，请尽快把他喝掉",    

 "url":"https://www.xxx.com "

}


必填字段：

userKey、mode、title、content、url（仅卡片类型必填）

参数说明

  1. userKey: 一个集合，Jira用户唯一标识（注意 User Key 不是 User ID）。

  2. mode: 钉钉消息通知的方式（整数类型: 1为文本，0为卡片）。

  3. title: 消息标题（String类型；不超过128个字节，超过截取）。

  4. content: 消息内容（String类型；html标签需要拼接，不超过512个字节，超过截取）。

  5. url: 卡片消息点击后跳转详情页面的url （String类型；请确保包含了协议头（http/https））。非卡片消息类型值可为空。


(3) 消息返回

消息返回格式示例：

{"code": "00000", "msg": "发送成功"}


返回内容为字符串，格式为JSON，UTF-8编码。含code和msg。


code为消息码，msg 为消息内容。


具体消息返回请参照下文：4. 消息码与消息内容一览表。


3. 日志记录

接口接收到的每一条请求报文，都会记录到 jira日志中，便于后期调试排错。


所有的错误与异常均记录在 atlassian-jira.log （jira application 日志）、catalina.out （jira tomcat 日志）。


4. 消息码与消息内容一览表

消息码

消息内容(中文)

00000

发送成功。

90000

参数构造不合法。

90001

DingTalk for Jira插件的许可无效。

90002

noticeToken不合法。

90003

用户不存在或未绑定企业微信用户。

90004

mode 参数不合法。

90005

title 参数不合法。

90006

发送格式为卡片时 url 不能为空。

90007

DingTalk for Jira插件的配置错误。

90008

Headers 中没有请求头。

90009

content 参数不合法。