消息中心模块

API域名以及签名 统一签名, 此模块路由地址为/open/v6

---

一、待办消息

1、发送待办消息

（1）接口地址:/todo/send

（2）请求方式:POST

（3）请求数据类型:application/json

（4）响应数据类型:*/*,application/json

（5）请求参数:

参数名称	数据类型	是否必须	参数说明
requestId	String	true	请求id，具有唯一性，作为幂等性标识字段
requestTime	String	true	请求时间，格式:yyyy-MM-dd HH:mm:ss
sourceBizId	String	true	来源业务id，业务唯一 注：消息有发送、撤回等操作 这一条消息要传同一个sourceBizId
sourceAppCode	String	true	来源应用编码(找对接人提供)
templateCode	String	false	模版编码
instanceId	String	false	审批实例id
instanceLink	Object	false	审批实例链接
└ pcLink	String	false	pc端的跳转链接，与移动端不能都为空
└ mobileLink	String	false	移动端的跳转链接，与pc端不能都为空
subject	String	true	待办标题
description	String	false	待办描述
dueTime	String	false	截止时间，格式:yyyy-MM-dd HH:mm:ss
personalIdType	Integer	true	人员id类型，1:userId 2:员工工号
creatorId	String	true	创建者用户id/员工工号
executorIdList	List	true	执行者用户id/员工工号
participantIdList	List	false	参与者用户id/员工工号
detailUrl	Object	false	任务链接
└ pcUrl	String	false	pc端详情页url跳转地址，与app端不能都为空
└ appUrl	String	false	app端详情页url跳转地址，与pc端不能都为空
priority	Integer	false	优先级 10：较低 20：普通 30：紧急 40：非常紧急

（6）请求示例:

{
  "requestId": "",
  "requestTime": "",
  "sourceBizId": "",
  "sourceAppCode": "",
  "templateCode": "",
  "instanceId": "",
  "instanceLink": {
    "mobileLink": "",
    "pcLink": ""
  },
  "subject": "",
  "description": "",
  "dueTime": "",
  "personalIdType": 1,
  "creatorId": "",
  "executorIdList": [],
  "participantIdList": [],
  "detailUrl": {
    "appUrl": "",
    "pcUrl": ""
  },
  "priority": 10
}

（7）响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功 其他失败
data	Boolean
message	String	返回信息

（8）响应示例:

{
  "code": 0,
  "data": true,
  "message": ""
}

---

2、更新待办消息

（1）接口地址:/todo/update

（2）请求方式:POST

（3）请求数据类型:application/json

（4）响应数据类型:*/*,application/json

（5）请求参数:

数据类型	参数名称	是否必须	参数说明
requestId	String	true	请求id，具有唯一性，作为幂等性标识字段
requestTime	String	true	请求时间，格式:yyyy-MM-dd HH:mm:ss
sourceBizId	String	true	来源业务id，业务唯一 注：消息有发送、撤回等操作 这一条消息要传同一个sourceBizId
sourceAppCode	String	true	来源应用编码(找对接人提供)
templateCode	String	false	模版编码
instanceId	String	false	审批实例id
instanceLink	Object	false	审批实例链接
└ pcLink	String	false	pc端的跳转链接，与移动端不能都为空
└ mobileLink	String	false	移动端的跳转链接，与pc端不能都为空
subject	String	true	待办标题
description	String	false	待办描述
dueTime	String	false	截止时间，格式:yyyy-MM-dd HH:mm:ss
personalIdType	Integer	false	人员id类型，1:userId 2:员工工号
operatorId	String	false	操作人用户id/员工工号
executorIdList	List	true	执行者用户id/员工工号
participantIdList	List	false	参与者用户id/员工工号
isDone	Boolean	false	待办状态 完成:true 未完成:false

（6）请求示例:

{
  "requestId": "",
  "requestTime": "",
  "sourceBizId": "",
  "sourceAppCode": "",
  "templateCode": "",
  "instanceId": "",
  "instanceLink": {
    "mobileLink": "",
    "pcLink": ""
  },
  "subject": "",
  "description": "",
  "dueTime": "",
  "personalIdType": 0,
  "operatorId": "",
  "executorIdList": [],
  "participantIdList": [],
  "isDone": true
}

（7）响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功 其他失败
data	Boolean
message	String	返回信息

（8）响应示例:

{
  "code": 0,
  "data": true,
  "message": ""
}

---

3、待办执行者状态更新

（1）接口地址:/todo/updateExecutorStatus

（2）请求方式:POST

（3）请求数据类型:application/json

（4）响应数据类型:*/*,application/json

（5）请求参数:

参数名称	数据类型	是否必须	参数说明
requestId	String	true	请求id，具有唯一性，作为幂等性标识字段
requestTime	String	true	请求时间，格式:yyyy-MM-dd HH:mm:ss
sourceBizId	String	true	来源业务id，业务唯一 注：消息有发送、撤回等操作 这一条消息要传同一个sourceBizId
sourceAppCode	String	true	来源应用编码(找对接人提供)
templateCode	String	false	模版编码
instanceId	String	false	审批实例id
personalIdType	Integer	true	人员id类型 1:userId 2:员工工号
operatorId	String	false	操作人用户id/员工工号
executorStatusList	List	true	执行者信息
└ executorId	String	true	执行者信息 用户id/工号
└ isDone	Boolean	true	待办状态 完成:true 未完成:false

（6）请求示例:

{
  "requestId": "",
  "requestTime": "",
  "sourceBizId": "",
  "sourceAppCode": "",
  "templateCode": "",
  "instanceId": "",
  "personalIdType": 1,
  "operatorId": "",
  "executorStatusList": [
    {
      "executorId": "",
      "isDone": true
    }
  ]
}

（7）响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功 其他失败
data	Boolean
message	String	返回信息

（8）响应示例:

{
  "code": 0,
  "data": true,
  "message": ""
}

---

4、删除待办消息

（1）接口地址:/todo/delete

（2）请求方式:POST

（3）请求数据类型:application/json

（4）响应数据类型:*/*,application/json

（5）请求参数:

参数名称	数据类型	是否必须	参数说明
requestId	String	true	请求id，具有唯一性，作为幂等性标识字段
requestTime	String	true	请求时间，格式:yyyy-MM-dd HH:mm:ss
sourceBizId	String	true	来源业务id，业务唯一 注：消息有发送、撤回等操作 这一条消息要传同一个sourceBizId
sourceAppCode	String	true	来源应用编码(找对接人提供)
templateCode	String	false	模版编码
instanceId	String	false	审批实例id
personalIdType	Integer	false	人员id类型，1:userId 2:员工工号
operatorId	String	false	操作人信息，用户id/员工工号

（6）请求示例:

{
  "requestId": "",
  "requestTime": "",
  "sourceBizId": "",
  "sourceAppCode": "",
  "templateCode": "",
  "instanceId": "",
  "personalIdType": 1,
  "operatorId": ""
}

（7）响应参数:

参数名称	类型	参数说明
code	Integer	0:成功 其他失败
data	Boolean
message	String	返回信息

（8）响应示例:

{
  "code": 0,
  "data": true,
  "message": ""
}

---

二、通知消息

1、发送通知消息

（1）接口地址:/notice/send

（2）请求方式:POST

（3）请求数据类型:application/json

（4）响应数据类型:*/*,application/json

（5）请求参数:

参数名称	数据类型	是否必须	参数说明
requestId	String	true	请求id，具有唯一性，作为幂等性标识字段
requestTime	String	true	请求时间，格式：yyyy-MM-dd HH:mm:ss
sourceBizId	String	true	来源业务id，业务唯一 注：消息有发送、撤回等操作 这一条消息要传同一个sourceBizId
sourceAppCode	String	true	来源应用编码(找对接人提供)
templateCode	String	false	模版编码(找对接人提供) 注：需要指定应用发消息或发送群时，必填
callType	Integer	true	发送类型 0:发送个人 1:发送部门 2:发送全员(已下线) 3:发送群
personalIdType	Integer	false	人员id类型 1:userId，2:员工工号 与 userIdList 搭配使用
userIdList	List	false	消息接收人 userId/工号 (1).发送个人时，必填； (2).发送群时，若想@个人，必填；不传则@所有人
deptIdList	List	false	接收者的部门id列表
msgTitle	String	false	消息标题
msg	Msg	true	消息内容

Msg:

参数名称	数据类型	是否必须	参数说明
msgType	String	true	消息通知类型 (暂不支持voice、file) text、image、voice、file、link、markdown、action_card
text	Text	false
image	Image	false
voice	Voice	false
file	File	false
link	Link	false
markdown	Markdown	false
actionCard	ActionCard	false

Text:

参数名称	数据类型	是否必须	参数说明
content	String	true	消息内容

Image:

参数名称	数据类型	是否必须	参数说明
imageUrl	String	true	图片地址 (1).大小不能超过 10 MB (2).支持格式：JPG、JPEG、PNG、WEBP、GIF、BMP、ICO、TIFF、HEIC

Voice:

参数名称	数据类型	是否必须	参数说明
voiceUrl	String	true	音频链接
duration	String	true	音频时长，正整数，小于60

File:

参数名称	数据类型	是否必须	参数说明
fileUrl	String	true	文件地址

Link:

参数名称	数据类型	是否必须	参数说明
themeColor	String	false	主题颜色，默认：wathet 可选值：blue、wathet、turquoise、green、yellow、orange、red、violet、indigo、grey
title	String	true	消息标题
text	String	true	消息内容，支持 markdown 语法
buttonText	String	false	按钮文本，默认：查看
messagePcUrl	String	false	pc端跳转url，与app端不能都为空
messageAppUrl	String	false	app端跳转url，与pc端不能都为空

Markdown:

参数名称	数据类型	是否必须	参数说明
themeColor	String	false	主题颜色，默认：wathet 可选值：blue、wathet、turquoise、green、yellow、orange、red、violet、indigo、grey
title	String	false	消息标题
text	String	true	消息内容，支持 markdown 语法

ActionCard:

参数名称	数据类型	是否必须	参数说明
themeColor	String	false	主题颜色，默认：wathet 可选值：blue、wathet、turquoise、green、yellow、orange、red、violet、indigo、grey
title	String	true	标题
content	String	true	消息内容，支持 markdown 语法
buttonElements	List	false	按钮列表
└ buttonText	String	true	按钮文本
└ buttonType	String	false	按钮类型，默认：default 可选值：default，primary，danger，laser
└ hoverTips	String	false	PC端，光标悬浮在按钮上方的文案提醒
└ behaviorType	String	true	交互类型，可选值：open_url，callback
└ actionUrl	String	false	跳转链接，behaviorType = open_url 必填
└ scene	String	false	交互场景标识，behaviorType = callback 必填 用于接收卡片消息回调时的唯一标识，开发者根据这个值，做不同的后续逻辑
└ callbackData	json	false	自定义回传数据，behaviorType = callback 选填

（6）请求示例:

{
  "requestId": "",
  "requestTime": "",
  "sourceBizId": "",
  "sourceAppCode": "",
  "templateCode": "",
  "callType": 0,
  "personalIdType": 1,
  "userIdList": [
    "111",
    "2222"
  ],
  "deptIdList": [],
  "msgTitle": "",
  "msg": {
    "msgType": "text",
    "text": {
      "content": ""
    },
    "image": {
      "imageUrl": ""
    },
    "voice": {
      "voiceUrl": "",
      "duration": ""
    },
    "file": {
      "fileUrl": ""
    },
    "link": {
      "themeColor": "",
      "title": "",
      "text": "",
      "messagePcUrl": "",
      "messageAppUrl": "",
      "picUrl": ""
    },
    "markdown": {
      "themeColor": "",
      "title": "",
      "text": ""
    },
    "actionCard": {
      "themeColor": "",
      "title": "",
      "content": "",
      "buttonElements": [
        {
          "buttonText": "",
          "buttonType": "",
          "hoverTips": "",
          "behaviorType": "",
          "actionUrl": "",
          "scene": "",
          "callbackData": {
            "key1": "value1",
            "key2": "value2"
          }
        }
      ]
    }
  }
}

（7）响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功 其他失败
data	Boolean
message	String	返回信息

（8）响应示例:

{
  "code": 0,
  "data": true,
  "message": ""
}

---

2、撤回通知消息

（1）接口地址:/notice/recall

（2）请求方式:POST

（3）请求数据类型:application/json

（4）响应数据类型:*/*,application/json

（5）请求参数:

参数名称	数据类型	是否必须	参数说明
requestId	String	true	请求id，具有唯一性，作为幂等性标识字段
requestTime	String	true	请求时间，格式:yyyy-MM-dd HH:mm:ss
sourceBizId	String	true	来源业务id，业务唯一 注：消息有发送、撤回等操作 这一条消息要传同一个sourceBizId
sourceAppCode	String	true	来源应用编码(找对接人提供)
templateCode	String	false	模版编码

（6）请求示例:

{
  "requestId": "",
  "requestTime": "",
  "sourceAppCode": "",
  "sourceBizId": "",
  "templateCode": ""
}

（7）响应参数:

参数名称	数据类型	参数说明
code	Integer	0:成功 其他失败
data	Boolean
message	String	返回信息

（8）响应示例:

{
  "code": 0,
  "data": true,
  "message": ""
}

三、发送短信消息

接口地址:/sms/send

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "templateCode": "",
  "requestId": "",
  "requestTime": "",
  "sourceBizId": "",
  "sourceAppCode": "",
  "signName": "",
  "content": "",
  "templateParam": {},
  "phoneNumbers": []
}

请求参数:

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
smsSendAO	短信消息发送AO	body	true	SmsSendAO	SmsSendAO
templateCode	模版编码，需要指定应用发消息或发送群时，必填(找对接人提供)		false	string
requestId	请求id,具有唯一性,作为幂等性标识字段		true	string
requestTime	请求时间 格式:yyyy-MM-dd HH:mm:ss		true	string(date-time)
sourceBizId	来源业务ID，一条消息对应一个唯一业务ID		true	string
sourceAppCode	来源应用编码		true	string
signName	短信签名		true	string
content	短信内容		true	string
templateParam	模板参数		false	object
phoneNumbers	发送人手机号码，最大 200		true	array	string

响应状态:

状态码	说明	schema
200	OK	HttpResultBoolean

响应参数:

参数名称	参数说明	类型	schema
code		integer(int32)	integer(int32)
data		boolean
message		string

响应示例:

{
	"code": 0,
	"data": true,
	"message": ""
}