消息服务接口文档V3.0

接口定义

发送消息

请求方式：POST

请求地址：./glink-msgc/message/send

模版消息

请求示例：

{
  "category": "1",
  "msgMobileUrl": "msgMobileUrl",
  "msgPcUrl": "msgPcUrl",
  "msgReadUrl": "msgReadUrl",
  "msgTitle": "张三请销假",
  "receiveProductCode": "productCode",
  "receiveProductName": "productName",
  "receiver": {
    "userIds": [
      "1"
    ],
    "userAccounts": [
      "admin"
    ],
    "userNames": [
      "admin"
    ]
  },
  "senderAppCode": "15413678834176",
  "senderAppName": "请销假",
  "senderUserId": "1",
  "senderUserName": "admin",
  "senderOrgId": "",
  "senderOrgName": "",
  "senderProjectCode": "",
  "senderProjectName": "",
  "templateCode": "QXJ.qingxiaojia",
  "templateParams": {
    "name": "张三",
    "number": 3
  },
  "projectManagerId": "1",
  "projectManagerName": "邓鹏飞",
  "contractLeaderId": "1",
  "contractLeaderName": "张国豪",
  "constructionSiteName": "部门组长"
}

参数说明：

参数	是否必须	说明
receiveProductCode	是	接收消息的产品编码
receiveProductName	是	接收消息的产品名称
templateCode	是	消息模版编码
category	是	消息级别
senderUserId	否	发送人id，系统自动发消息时，可为空
senderUserName	否	发送人名称，系统自动发消息时，可为空
senderAppCode	是	发送应用编码
senderAppName	是	发送应用名称
senderOrgId	是	发送方组织id
senderOrgName	是	发送方组织名称
senderProjectCode	是	发送方工程项目编码
senderProjectName	是	发送方工程项目名称
receiver	是	接收对象
receiver.userIds	是	接收人id集合
receiver.userAccounts	是	接收人账号集合，userIds为空时生效
receiver.userNames	是	接收人名称集合
msgTitle	是	消息标题
msgPcUrl	否	消息PC端地址，只作用于企业微信
msgMobileUrl	否	消息移动端地址，只作用于企业微信
msgReadUrl	否	消息阅读回调地址，只作用于站内消息
templateParams	否	消息模版参数
projectManagerId	否	项目经理id
projectManagerName	否	项目经理姓名
contractLeaderId	否	包保领导id
contractLeaderName	否	包保领导姓名
constructionSiteName	否	工号名称

返回示例：

{
    "uuid": "6fb45586-67c5-4b09-97a8-7145f2f03e5c",
    "code": "000000",
    "msg": "成功",
    "data": "b85e5d2697344d2b9705f6f7b335b1c6",
    "ok": true
}

注：data 中为消息回执id: msgId

撤回消息

请求方式：GET

请求地址：./glink-msgc/message/revoke

模版消息

请求示例：

./glink-msgc/message/revoke?msgId=b85e5d2697344d2b9705f6f7b335b1c6

参数说明：

参数	是否必须	说明
msgId	是	消息回执id

返回示例：

{
    "uuid": "6fb45586-67c5-4b09-97a8-7145f2f03e5c",
    "code": "000000",
    "msg": "成功",
    "data": true,
    "ok": true
}

消息列表查询

请求方式：GET

请求地址：./glink-msgc/station/pageList

请求示例：

./glink-msgc/message/station/pageList?currentPage=1&pageSize=10&readTag=0&terminalCode=PORTAL_MESSAGE

参数说明：

参数	是否必须	说明
currentPage	是	当前页数
pageSize	是	每页记录数
terminalCode	是	消息终端编码，门户消息：PORTAL_MESSAGE，预警消息：PORTAL_ALERT，通报消息：PORTAL_NOTICE
senderName	否	发送应用名称或发送人名称
keyword	否	关键字，消息标题或消息内容
readTag	否	已读未读标志，0-未读，1-已读
receivedTimeStart	否	接收时间-开始时间
receivedTimeEnd	否	接收时间-结束时间

返回示例：

{
	"uuid": "4d7728d3-04ed-48cb-a77f-72cbda403ee9",
	"code": "000000",
	"msg": "成功",
	"data": {
		"records": [{
			"id": "1587779570680479744",
			"tenantId": "1527589324236275712",
			"msgId": "62010ab09be54a2d9e716c8559144abf",
			"msgTitle": "待办提醒",
			"msgContent": "待办消息提醒",
			"category": "1",
			"senderUserId": "1",
			"senderUserName": "admin",
			"senderAppCode": "15413678834176",
			"senderAppName": "请销假",
			"senderOrgId": null,
			"senderOrgName": null,
			"senderProjectCode": null,
			"senderProjectName": null,
			"receiveProductCode": "productCode",
			"receiveProductName": "productName",
			"receivedTime": 1667391124000,
			"msgReadUrl": "msgReadUrl",
			"terminalName": "门户提醒",
			"terminalCode": "PORTAL_MESSAGE",
			"revokeTag": 0,
			"projectManagerId": null,
			"projectManagerName": null,
			"contractLeaderId": null,
			"contractLeaderName": null,
			"constructionSiteName": null,
			"createTime": 1667391124000
		}],
		"total": 1,
		"size": 10,
		"current": 1,
		"orders": [],
		"optimizeCountSql": true,
		"searchCount": true,
		"countId": null,
		"maxLimit": null,
		"pages": 1
	},
	"ok": true
}

消息标记已读

请求方式：GET

请求地址：./glink-msgc/message/readByMsgId

请求示例：

./glink-msgc/message/readByMsgId?msgId=b85e5d2697344d2b9705f6f7b335b1c6&userId=1

参数说明：

参数	是否必须	说明
msgId	是	消息回执id
userId	是	用户id

返回示例：

{
    "uuid": "6fb45586-67c5-4b09-97a8-7145f2f03e5c",
    "code": "000000",
    "msg": "成功",
    "data": true,
    "ok": true
}