ThingsKit

Appearance

Return to top
本页目录

 

ThingsKit物联网平台

开箱即用的物联网低代码平台

新增消息模板

接口地址:/api/yt/template

请求方式:POST

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

响应数据类型:*/*

请求示例:

javascript
{
  "id": "",
  "messageConfig": {
    "config": {},
    "configName": "",
    "messageType": "",
    "name": "",
    "platformType": ""
  },
  "messageConfigId": "",
  "messageType": "",
  "name": "",  
  "signName": ""
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

请求参数:

参数名称参数说明请求类型是否必须数据类型
messageTemplateDTOMessageTemplateDTObodytrueMessageTemplateDTO
  createTime创建时间falsestring(date-time)
  creator创建用户falsestring
  defaultConfig租户默认配置falsestring
  description租户描述falsestring
  enabled租户状态：启用/禁用falseboolean
  icon租户图标falsestring
  idIDfalsestring
  messageConfig消息配置信息falseMessageConfigDTO
    config消息相关json配置falseJsonNode
    configName配置名称falsestring
    createTime创建时间falsestring
    creator创建用户falsestring
    defaultConfig租户默认配置falsestring
    description租户描述falsestring
    enabled租户状态：启用/禁用falseboolean
    icon租户图标falsestring
    idIDfalsestring
    messageType消息类型falsestring
    name租户名称falsestring
    platformType短信平台类型falsestring
    remark备注falsestring
    roleIds租户角色列表falsearray
    status状态：0禁用 1启用falseinteger
    tenantExpireTime租户到期时间falsestring
    tenantId租户IDfalsestring
    tenantProfileId租户配置falsestring
    tenantStatus可用值:DISABLED,EXPIRED,NORMALfalsestring
    updateTime更新时间falsestring
    updater更新用户falsestring
  messageConfigId消息配置falsestring
  messageType消息类型falsestring
  name租户名称falsestring
  roleIds租户角色列表falsearray
  signName模板签名falsestring
  status状态：0禁用 1启用falseinteger(int32)
  templateCode模板CODEfalsestring
  templateName模板名称falsestring
  templatePurpose模板用途falsestring
  tenantExpireTime租户到期时间falsestring(date-time)
  tenantId租户IDfalsestring
  tenantProfileId租户配置falsestring
  tenantStatus可用值:DISABLED,EXPIRED,NORMALfalsestring
  updateTime更新时间falsestring(date-time)
  updater更新用户falsestring

响应参数:

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

响应示例:

javascript
{
	"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": ""
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

修改消息模板

接口地址:/api/yt/template

请求方式:PUT

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

响应数据类型:*/*

请求示例:

javascript
{
  "messageConfig": {
    "config": {},
    "configName": "",
    "messageType": "",
    "name": "",
    "platformType": "",
  },
  "messageConfigId": "",
  "messageType": "",
  "name": "",
  "signName": ""
}
1
2
3
4
5
6
7
8
9
10
11
12
13

请求参数:

参数名称参数说明请求类型是否必须数据类型
messageTemplateDTOMessageTemplateDTObodytrueMessageTemplateDTO
  createTime创建时间falsestring(date-time)
  creator创建用户falsestring
  defaultConfig租户默认配置falsestring
  description租户描述falsestring
  enabled租户状态：启用/禁用falseboolean
  icon租户图标falsestring
  idIDfalsestring
  messageConfig消息配置信息falseMessageConfigDTO
    config消息相关json配置falseJsonNode
    configName配置名称falsestring
    createTime创建时间falsestring
    creator创建用户falsestring
    defaultConfig租户默认配置falsestring
    description租户描述falsestring
    enabled租户状态：启用/禁用falseboolean
    icon租户图标falsestring
    idIDfalsestring
    messageType消息类型falsestring
    name租户名称falsestring
    platformType短信平台类型falsestring
    remark备注falsestring
    roleIds租户角色列表falsearray
    status状态：0禁用 1启用falseinteger
    tenantExpireTime租户到期时间falsestring
    tenantId租户IDfalsestring
    tenantProfileId租户配置falsestring
    tenantStatus可用值:DISABLED,EXPIRED,NORMALfalsestring
    updateTime更新时间falsestring
    updater更新用户falsestring
  messageConfigId消息配置falsestring
  messageType消息类型falsestring
  name租户名称falsestring
  roleIds租户角色列表falsearray
  signName模板签名falsestring
  status状态：0禁用 1启用falseinteger(int32)
  templateCode模板CODEfalsestring
  templateName模板名称falsestring
  templatePurpose模板用途falsestring
  tenantExpireTime租户到期时间falsestring(date-time)
  tenantId租户IDfalsestring
  tenantProfileId租户配置falsestring
  tenantStatus可用值:DISABLED,EXPIRED,NORMALfalsestring
  updateTime更新时间falsestring(date-time)
  updater更新用户falsestring

响应参数:

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

响应示例:

javascript
{
	"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": ""
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

删除消息模板

接口地址:/api/yt/template

请求方式:DELETE

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

响应数据类型:*/*

请求示例:

javascript
{
  "ids": [],
  "tenantId": ""
}
1
2
3
4

请求参数:

参数名称参数说明请求类型是否必须数据类型
deleteDTODeleteDTObodytrueDeleteDTO
  ids删除ID列表truearray
  tenantId租户IDfalsestring

响应参数:

参数名称参数说明类型
codeinteger(int32)
datastring
messagestring

响应示例:

javascript
{
	"code": 0,
	"data": "",
	"message": ""
}
1
2
3
4
5

模板邮件发送

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

请求方式:POST

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

响应数据类型:*/*

请求示例:

javascript
{
  "bcc": [],
  "body": "",
  "cc": [],
  "emailFormatEnum": "",
  "files": [],
  "id": "",
  "remark": "",
  "subject": "",
  "templatePurpose": "",
  "to": []
}
1
2
3
4
5
6
7
8
9
10
11
12

请求参数:

参数名称参数说明请求类型是否必须数据类型
emailReqDTOEmailReqDTObodytrueEmailReqDTO
  bccfalsearray
  bodyfalsestring
  ccfalsearray
  emailFormatEnumfalsestring
  filesfalsearray
  idfalsestring
  remarkfalsestring
  subjecttruestring
  templatePurposefalsestring
  tofalsearray

响应参数:

参数名称参数说明类型
codeinteger(int32)
datastring
messagestring

响应示例:

javascript
{
	"code": 0,
	"data": "",
	"message": ""
}
1
2
3
4
5

模板短信发送

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

请求方式:POST

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

响应数据类型:*/*

请求示例:

javascript
{
  "id": "",
  "params": {},
  "phoneNumbers": "",
  "remark": "",
  "templatePurpose": ""
}
1
2
3
4
5
6
7

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
smsReqDTOSmsReqDTObodytrueSmsReqDTOSmsReqDTO
  idtruestring
  paramsfalseobject
  phoneNumbersfalsestring
  remarkfalsestring
  templatePurposefalsestring

响应参数:

参数名称参数说明类型schema
codeinteger(int32)integer(int32)
datastring
messagestring

响应示例:

javascript
{
	"code": 0,
	"data": "",
	"message": ""
}
1
2
3
4
5

模板分页

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

请求方式:GET

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

响应数据类型:*/*

请求参数:

参数名称参数说明是否必须数据类型
pagepagetrueint
pageSizepageSizetrueint
templateCodetemplateCodefalsestring
templateNametemplateNamefalsestring
orderFiledorderFiledfalsestring
orderTypeorderType,可用值:ASC,DESCfalsestring

响应参数:

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

响应示例:

javascript
{
	"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
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

@ 2023 云腾五洲 蜀ICP备2020033344号