ThingsKit物联网平台API文档-消息管理（消息记录）

短信记录分页

接口地址:/api/yt/sms_log{?endTime,orderFiled,orderType,page,pageSize,startTime,toPhone}

请求方式:GET

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

响应数据类型:*/*

请求参数:

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

响应参数:

参数名称	参数说明	类型
items		array
createTime	创建时间	string(date-time)
creator	创建用户	string
id	ID	string
messageTemplateId	消息模板ID	string
remark	备注	string
sendTime	发送时间	string(date-time)
status	发送状态	string
templateParam	发送模板参数	JsonNode
templatePurpose	模板用途	string
tenantId	租户Code	string
toPhone	发送手机号	string
type	短信平台类型	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
total		integer(int32)

响应示例:

{
	"items": [
		{
			"createTime": "",
			"creator": "",
			"id": "",
			"messageTemplateId": "",
			"remark": "",
			"sendTime": "",
			"status": "",
			"templateParam": {},
			"templatePurpose": "",
			"tenantId": "",
			"toPhone": "",
			"type": "",
			"updateTime": "",
			"updater": ""
		}
	],
	"total": 0
}

删除短信记录

接口地址:/api/yt/sms_log

请求方式: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/mail_log{?emailSubject,endTime,orderFiled,orderType,page,pageSize,startTime}

请求方式:GET

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

响应数据类型:*/*

请求参数:

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

响应参数:

参数名称	参数说明	类型
items		array
createTime	创建时间	string(date-time)
creator	创建用户	string
emailBcc	密送人	JsonNode
emailBody	邮件内容	string
emailCc	抄送人	JsonNode
emailFrom	发件人	string
emailSubject	邮件主题	string
emailTo	收件人	JsonNode
id	ID	string
messageTemplateId	模板ID	string
remark	备注	string
sendTime	发送时间	string(date-time)
status	发送状态	string
templatePurpose	模板用途	string
tenantId	租户ID	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
total		integer(int32)

响应示例:

{
	"items": [
		{
			"createTime": "",
			"creator": "",
			"emailBcc": {},
			"emailBody": "",
			"emailCc": {},
			"emailFrom": "",
			"emailSubject": "",
			"emailTo": {},
			"id": "",
			"messageTemplateId": "",
			"remark": "",
			"sendTime": "",
			"status": "",
			"templatePurpose": "",
			"tenantId": "",
			"updateTime": "",
			"updater": ""
		}
	],
	"total": 0
}

删除邮件记录

接口地址:/api/yt/mail_log

请求方式: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": ""
}