ThingsKit物联网平台API文档-监控运维（消息管理-消息模板）

云腾小编

2024年11月6日2024年11月5日

新增消息模板

接口地址:/api/yt/template

请求方式:POST

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

响应数据类型:*/*

请求示例:

{
  "id": "",
  "messageConfig": {
    "config": {},
    "configName": "",
    "messageType": "",
    "name": "",
    "platformType": ""
  },
  "messageConfigId": "",
  "messageType": "",
  "name": "",  
  "signName": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
messageTemplateDTO	MessageTemplateDTO	body	true	MessageTemplateDTO
createTime	创建时间		false	string(date-time)
creator	创建用户		false	string
defaultConfig	租户默认配置		false	string
description	租户描述		false	string
enabled	租户状态：启用/禁用		false	boolean
icon	租户图标		false	string
id	ID		false	string
messageConfig	消息配置信息		false	MessageConfigDTO
config	消息相关json配置		false	JsonNode
configName	配置名称		false	string
createTime	创建时间		false	string
creator	创建用户		false	string
defaultConfig	租户默认配置		false	string
description	租户描述		false	string
enabled	租户状态：启用/禁用		false	boolean
icon	租户图标		false	string
id	ID		false	string
messageType	消息类型		false	string
name	租户名称		false	string
platformType	短信平台类型		false	string
remark	备注		false	string
roleIds	租户角色列表		false	array
status	状态：0禁用 1启用		false	integer
tenantExpireTime	租户到期时间		false	string
tenantId	租户ID		false	string
tenantProfileId	租户配置		false	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL		false	string
updateTime	更新时间		false	string
updater	更新用户		false	string
messageConfigId	消息配置		false	string
messageType	消息类型		false	string
name	租户名称		false	string
roleIds	租户角色列表		false	array
signName	模板签名		false	string
status	状态：0禁用 1启用		false	integer(int32)
templateCode	模板CODE		false	string
templateName	模板名称		false	string
templatePurpose	模板用途		false	string
tenantExpireTime	租户到期时间		false	string(date-time)
tenantId	租户ID		false	string
tenantProfileId	租户配置		false	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL		false	string
updateTime	更新时间		false	string(date-time)
updater	更新用户		false	string

响应参数:

参数名称	参数说明	类型
code		integer(int32)
data		MessageTemplateDTO
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
messageConfig	消息配置信息	MessageConfigDTO
config	消息相关json配置	JsonNode
configName	配置名称	string
createTime	创建时间	string
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
messageType	消息类型	string
name	租户名称	string
platformType	短信平台类型	string
remark	备注	string
roleIds	租户角色列表	array
status	状态：0禁用 1启用	integer
tenantExpireTime	租户到期时间	string
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
updateTime	更新时间	string
updater	更新用户	string
messageConfigId	消息配置	string
messageType	消息类型	string
name	租户名称	string
roleIds	租户角色列表	array
signName	模板签名	string
status	状态：0禁用 1启用	integer(int32)
templateCode	模板CODE	string
templateName	模板名称	string
templatePurpose	模板用途	string
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
message		string

响应示例:

{
	"code": 0,
	"data": {
		"createTime": "",
		"creator": "",
		"defaultConfig": "",
		"description": "",
		"enabled": false,
		"icon": "",
		"id": "",
		"messageConfig": {
			"config": {},
			"configName": "",
			"createTime": "",
			"creator": "",
			"defaultConfig": "",
			"description": "",
			"enabled": false,
			"icon": "",
			"id": "",
			"messageType": "",
			"name": "",
			"platformType": "",
			"remark": "",
			"roleIds": [],
			"status": 0,
			"tenantExpireTime": "",
			"tenantId": "",
			"tenantProfileId": "",
			"tenantStatus": "",
			"updateTime": "",
			"updater": ""
		},
		"messageConfigId": "",
		"messageType": "",
		"name": "",
		"roleIds": [],
		"signName": "",
		"status": 0,
		"templateCode": "",
		"templateName": "",
		"templatePurpose": "",
		"tenantExpireTime": "",
		"tenantId": "",
		"tenantProfileId": "",
		"tenantStatus": "",
		"updateTime": "",
		"updater": ""
	},
	"message": ""
}

修改消息模板

接口地址:/api/yt/template

请求方式:PUT

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

响应数据类型:*/*

请求示例:

{
  "messageConfig": {
    "config": {},
    "configName": "",
    "messageType": "",
    "name": "",
    "platformType": "",
  },
  "messageConfigId": "",
  "messageType": "",
  "name": "",
  "signName": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
messageTemplateDTO	MessageTemplateDTO	body	true	MessageTemplateDTO
createTime	创建时间		false	string(date-time)
creator	创建用户		false	string
defaultConfig	租户默认配置		false	string
description	租户描述		false	string
enabled	租户状态：启用/禁用		false	boolean
icon	租户图标		false	string
id	ID		false	string
messageConfig	消息配置信息		false	MessageConfigDTO
config	消息相关json配置		false	JsonNode
configName	配置名称		false	string
createTime	创建时间		false	string
creator	创建用户		false	string
defaultConfig	租户默认配置		false	string
description	租户描述		false	string
enabled	租户状态：启用/禁用		false	boolean
icon	租户图标		false	string
id	ID		false	string
messageType	消息类型		false	string
name	租户名称		false	string
platformType	短信平台类型		false	string
remark	备注		false	string
roleIds	租户角色列表		false	array
status	状态：0禁用 1启用		false	integer
tenantExpireTime	租户到期时间		false	string
tenantId	租户ID		false	string
tenantProfileId	租户配置		false	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL		false	string
updateTime	更新时间		false	string
updater	更新用户		false	string
messageConfigId	消息配置		false	string
messageType	消息类型		false	string
name	租户名称		false	string
roleIds	租户角色列表		false	array
signName	模板签名		false	string
status	状态：0禁用 1启用		false	integer(int32)
templateCode	模板CODE		false	string
templateName	模板名称		false	string
templatePurpose	模板用途		false	string
tenantExpireTime	租户到期时间		false	string(date-time)
tenantId	租户ID		false	string
tenantProfileId	租户配置		false	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL		false	string
updateTime	更新时间		false	string(date-time)
updater	更新用户		false	string

响应参数:

参数名称	参数说明	类型
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
messageConfig	消息配置信息	MessageConfigDTO
config	消息相关json配置	JsonNode
configName	配置名称	string
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
messageType	消息类型	string
name	租户名称	string
platformType	短信平台类型	string
remark	备注	string
roleIds	租户角色列表	array
status	状态：0禁用 1启用	integer(int32)
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
messageConfigId	消息配置	string
messageType	消息类型	string
name	租户名称	string
roleIds	租户角色列表	array
signName	模板签名	string
status	状态：0禁用 1启用	integer(int32)
templateCode	模板CODE	string
templateName	模板名称	string
templatePurpose	模板用途	string
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
updateTime	更新时间	string(date-time)
updater	更新用户	string

响应示例:

{
	"createTime": "",
	"creator": "",
	"defaultConfig": "",
	"description": "",
	"enabled": false,
	"icon": "",
	"id": "",
	"messageConfig": {
		"config": {},
		"configName": "",
		"createTime": "",
		"creator": "",
		"defaultConfig": "",
		"description": "",
		"enabled": false,
		"icon": "",
		"id": "",
		"messageType": "",
		"name": "",
		"platformType": "",
		"remark": "",
		"roleIds": [],
		"status": 0,
		"tenantExpireTime": "",
		"tenantId": "",
		"tenantProfileId": "",
		"tenantStatus": "",
		"updateTime": "",
		"updater": ""
	},
	"messageConfigId": "",
	"messageType": "",
	"name": "",
	"roleIds": [],
	"signName": "",
	"status": 0,
	"templateCode": "",
	"templateName": "",
	"templatePurpose": "",
	"tenantExpireTime": "",
	"tenantId": "",
	"tenantProfileId": "",
	"tenantStatus": "",
	"updateTime": "",
	"updater": ""
}

删除消息模板

接口地址:/api/yt/template

请求方式:DELETE

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

响应数据类型:*/*

请求示例:

{
  "ids": [],
  "tenantId": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
deleteDTO	DeleteDTO	body	true	DeleteDTO
ids	删除ID列表		true	array
tenantId	租户ID		false	string

响应参数:

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

响应示例:

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

模板邮件发送

接口地址:/api/yt/template/send_email

请求方式:POST

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

响应数据类型:*/*

请求示例:

{
  "bcc": [],
  "body": "",
  "cc": [],
  "emailFormatEnum": "",
  "files": [],
  "id": "",
  "remark": "",
  "subject": "",
  "templatePurpose": "",
  "to": []
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
emailReqDTO	EmailReqDTO	body	true	EmailReqDTO
bcc			false	array
body			false	string
cc			false	array
emailFormatEnum			false	string
files			false	array
id			false	string
remark			false	string
subject			true	string
templatePurpose			false	string
to			false	array

响应参数:

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

响应示例:

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

模板短信发送

接口地址:/api/yt/template/send_sms

请求方式:POST

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

响应数据类型:*/*

请求示例:

{
  "id": "",
  "params": {},
  "phoneNumbers": "",
  "remark": "",
  "templatePurpose": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型	schema
smsReqDTO	SmsReqDTO	body	true	SmsReqDTO	SmsReqDTO
id			true	string
params			false	object
phoneNumbers			false	string
remark			false	string
templatePurpose			false	string

响应参数:

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

响应示例:

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

模板分页

接口地址:/api/yt/template{?orderFiled,orderType,page,pageSize,templateCode,templateName}

请求方式:GET

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

响应数据类型:*/*

请求参数:

参数名称	参数说明	是否必须	数据类型
page	page	true	int
pageSize	pageSize	true	int
templateCode	templateCode	false	string
templateName	templateName	false	string
orderFiled	orderFiled	false	string
orderType	orderType,可用值:ASC,DESC	false	string

响应参数:

参数名称	参数说明	类型
items		array
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
messageConfig	消息配置信息	MessageConfigDTO
config	消息相关json配置	JsonNode
configName	配置名称	string
createTime	创建时间	string
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
messageType	消息类型	string
name	租户名称	string
platformType	短信平台类型	string
remark	备注	string
roleIds	租户角色列表	array
status	状态：0禁用 1启用	integer
tenantExpireTime	租户到期时间	string
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
updateTime	更新时间	string
updater	更新用户	string
messageConfigId	消息配置	string
messageType	消息类型	string
name	租户名称	string
roleIds	租户角色列表	array
signName	模板签名	string
status	状态：0禁用 1启用	integer(int32)
templateCode	模板CODE	string
templateName	模板名称	string
templatePurpose	模板用途	string
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
total		integer(int32)

响应示例:

{
	"items": [
		{
			"createTime": "",
			"creator": "",
			"defaultConfig": "",
			"description": "",
			"enabled": false,
			"icon": "",
			"id": "",
			"messageConfig": {
				"config": {},
				"configName": "",
				"createTime": "",
				"creator": "",
				"defaultConfig": "",
				"description": "",
				"enabled": false,
				"icon": "",
				"id": "",
				"messageType": "",
				"name": "",
				"platformType": "",
				"remark": "",
				"roleIds": [],
				"status": 0,
				"tenantExpireTime": "",
				"tenantId": "",
				"tenantProfileId": "",
				"tenantStatus": "",
				"updateTime": "",
				"updater": ""
			},
			"messageConfigId": "",
			"messageType": "",
			"name": "",
			"roleIds": [],
			"signName": "",
			"status": 0,
			"templateCode": "",
			"templateName": "",
			"templatePurpose": "",
			"tenantExpireTime": "",
			"tenantId": "",
			"tenantProfileId": "",
			"tenantStatus": "",
			"updateTime": "",
			"updater": ""
		}
	],
	"total": 0
}