ThingsKit物联网平台API文档-系统管理（平台通知-通知管理）

云腾小编

2024年11月8日2024年11月7日

我的通知分页

接口地址:/api/yt/notice_user/page{?orderFiled,orderType,page,pageSize,type}

请求方式:GET

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

响应数据类型:*/*

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
page	page	query	true	string
pageSize	pageSize	query	true	string
type	type,可用值:MEETING,NOTICE,OTHER	query	false	string
orderFiled	orderFiled	query	false	string
orderType	orderType,可用值:ASC,DESC	query	false	string

响应参数:

参数名称	参数说明	类型
items		array
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
name	租户名称	string
noticeId	通知ID	string
readDate	阅读时间	string(date-time)
readStatus	阅读状态 0：未读 1：已读	string
receiverId	接收者ID	string
receiverName	接收者	string
roleIds	租户角色列表	array
senderName	发送者	string
sysNotice	通知管理	通知管理
avatar	头像	string
content	内容	string
createTime	创建时间	string
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
name	租户名称	string
pointId	根据receiverType不同变化，0:传null，1:组织id，2:部门id，3:用户id	string
receiverType	接收者（字典值receiver_type） 0：全部 1：组织 2：部门 3：个人	integer
roleIds	租户角色列表	array
senderDate	发送时间	string
senderName	发送者	string
status	发送状态（字典值draft_status） 0：草稿 1：已发布	integer
tenantExpireTime	租户到期时间	string
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
title	标题	string
type	通知类型,可用值:MEETING,NOTICE,OTHER	string
updateTime	更新时间	string
updater	更新用户	string
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
type	通知类型,可用值:MEETING,NOTICE,OTHER	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
user	用户信息	UserDTO
accountExpireTime	账号失效时间	string
activateToken	激活token	string
avatar	头像	string
createTime	创建时间	string
creator	创建用户	string
customerId	客户ID	string
email	邮箱	string
enabled	账号状态	boolean
hasPassword	是否已重置密码	boolean
id	ID	string
level	角色级别：0：超级管理员；1：平台管理员 2：租户账号 3：租户下的账号	integer
organizationIds	所辖组织ids	array
password	密码	string
phoneNumber	电话号码	string
realName	真实名称	string
remark	备注	string
roleIds	角色ids	array
roles	角色信息列表	array
roleId	角色ID	string
roleName	角色名称	string
tbUser	TB的UserId	string
tenantId	租户ID	string
tenantName	租户名称	string
updateTime	更新时间	string
updater	更新用户	string
userStatusEnum	用户状态,可用值:DISABLED,EXPIRED,NORMAL	string
username	用户名	string
total		integer(int32)

响应示例:

{
	"items": [
		{
			"createTime": "",
			"creator": "",
			"defaultConfig": "",
			"description": "",
			"enabled": false,
			"icon": "",
			"id": "",
			"name": "",
			"noticeId": "",
			"readDate": "",
			"readStatus": "",
			"receiverId": "",
			"receiverName": "",
			"roleIds": [],
			"senderName": "",
			"sysNotice": {
				"avatar": "",
				"content": "",
				"createTime": "",
				"creator": "",
				"defaultConfig": "",
				"description": "",
				"enabled": false,
				"icon": "",
				"id": "",
				"name": "",
				"pointId": "",
				"receiverType": 0,
				"roleIds": [],
				"senderDate": "",
				"senderName": "",
				"status": 0,
				"tenantExpireTime": "",
				"tenantId": "",
				"tenantProfileId": "",
				"tenantStatus": "",
				"title": "",
				"type": "",
				"updateTime": "",
				"updater": ""
			},
			"tenantExpireTime": "",
			"tenantId": "",
			"tenantProfileId": "",
			"tenantStatus": "",
			"type": "",
			"updateTime": "",
			"updater": "",
			"user": {
				"accountExpireTime": "",
				"activateToken": "",
				"avatar": "",
				"createTime": "",
				"creator": "",
				"customerId": "",
				"email": "",
				"enabled": false,
				"hasPassword": false,
				"id": "",
				"level": 0,
				"organizationIds": [],
				"password": "",
				"phoneNumber": "",
				"realName": "",
				"remark": "",
				"roleIds": [],
				"roles": [
					{
						"roleId": "",
						"roleName": ""
					}
				],
				"tbUser": "",
				"tenantId": "",
				"tenantName": "",
				"updateTime": "",
				"updater": "",
				"userStatusEnum": "",
				"username": ""
			}
		}
	],
	"total": 0
}

查看人员阅读情况分页

接口地址:/api/yt/notice_user/read{?orderFiled,orderType,page,pageSize}

请求方式:GET

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

响应数据类型:*/*

请求参数:

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

响应参数:

参数名称	参数说明	类型
items		array
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
name	租户名称	string
noticeId	通知ID	string
readDate	阅读时间	string(date-time)
readStatus	阅读状态 0：未读 1：已读	string
receiverId	接收者ID	string
receiverName	接收者	string
roleIds	租户角色列表	array
senderName	发送者	string
sysNotice	通知管理	通知管理
avatar	头像	string
content	内容	string
createTime	创建时间	string
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
name	租户名称	string
pointId	根据receiverType不同变化，0:传null，1:组织id，2:部门id，3:用户id	string
receiverType	接收者（字典值receiver_type） 0：全部 1：组织 2：部门 3：个人	integer
roleIds	租户角色列表	array
senderDate	发送时间	string
senderName	发送者	string
status	发送状态（字典值draft_status） 0：草稿 1：已发布	integer
tenantExpireTime	租户到期时间	string
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
title	标题	string
type	通知类型,可用值:MEETING,NOTICE,OTHER	string
updateTime	更新时间	string
updater	更新用户	string
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
type	通知类型,可用值:MEETING,NOTICE,OTHER	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
user	用户信息	UserDTO
accountExpireTime	账号失效时间	string
activateToken	激活token	string
avatar	头像	string
createTime	创建时间	string
creator	创建用户	string
customerId	客户ID	string
email	邮箱	string
enabled	账号状态	boolean
hasPassword	是否已重置密码	boolean
id	ID	string
level	角色级别：0：超级管理员；1：平台管理员 2：租户账号 3：租户下的账号	integer
organizationIds	所辖组织ids	array
password	密码	string
phoneNumber	电话号码	string
realName	真实名称	string
remark	备注	string
roleIds	角色ids	array
roles	角色信息列表	array
roleId	角色ID	string
roleName	角色名称	string
tbUser	TB的UserId	string
tenantId	租户ID	string
tenantName	租户名称	string
updateTime	更新时间	string
updater	更新用户	string
userStatusEnum	用户状态,可用值:DISABLED,EXPIRED,NORMAL	string
username	用户名	string
total		integer(int32)

响应示例:

{
	"items": [
		{
			"createTime": "",
			"creator": "",
			"defaultConfig": "",
			"description": "",
			"enabled": false,
			"icon": "",
			"id": "",
			"name": "",
			"noticeId": "",
			"readDate": "",
			"readStatus": "",
			"receiverId": "",
			"receiverName": "",
			"roleIds": [],
			"senderName": "",
			"sysNotice": {
				"avatar": "",
				"content": "",
				"createTime": "",
				"creator": "",
				"defaultConfig": "",
				"description": "",
				"enabled": false,
				"icon": "",
				"id": "",
				"name": "",
				"pointId": "",
				"receiverType": 0,
				"roleIds": [],
				"senderDate": "",
				"senderName": "",
				"status": 0,
				"tenantExpireTime": "",
				"tenantId": "",
				"tenantProfileId": "",
				"tenantStatus": "",
				"title": "",
				"type": "",
				"updateTime": "",
				"updater": ""
			},
			"tenantExpireTime": "",
			"tenantId": "",
			"tenantProfileId": "",
			"tenantStatus": "",
			"type": "",
			"updateTime": "",
			"updater": "",
			"user": {
				"accountExpireTime": "",
				"activateToken": "",
				"avatar": "",
				"createTime": "",
				"creator": "",
				"customerId": "",
				"email": "",
				"enabled": false,
				"hasPassword": false,
				"id": "",
				"level": 0,
				"organizationIds": [],
				"password": "",
				"phoneNumber": "",
				"realName": "",
				"remark": "",
				"roleIds": [],
				"roles": [
					{
						"roleId": "",
						"roleName": ""
					}
				],
				"tbUser": "",
				"tenantId": "",
				"tenantName": "",
				"updateTime": "",
				"updater": "",
				"userStatusEnum": "",
				"username": ""
			}
		}
	],
	"total": 0
}

我的通知详情

接口地址:/api/yt/notice_user/{id}

请求方式:GET

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

响应数据类型:*/*

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
id	id	path	true	string

响应参数:

参数名称	参数说明	类型
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
name	租户名称	string
noticeId	通知ID	string
readDate	阅读时间	string(date-time)
readStatus	阅读状态 0：未读 1：已读	string
receiverId	接收者ID	string
receiverName	接收者	string
roleIds	租户角色列表	array
senderName	发送者	string
sysNotice	通知管理	通知管理
avatar	头像	string
content	内容	string
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
name	租户名称	string
pointId	根据receiverType不同变化，0:传null，1:组织id，2:部门id，3:用户id	string
receiverType	接收者（字典值receiver_type） 0：全部 1：组织 2：部门 3：个人	integer(int32)
roleIds	租户角色列表	array
senderDate	发送时间	string(date-time)
senderName	发送者	string
status	发送状态（字典值draft_status） 0：草稿 1：已发布	integer(int32)
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
title	标题	string
type	通知类型,可用值:MEETING,NOTICE,OTHER	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
type	通知类型,可用值:MEETING,NOTICE,OTHER	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
user	用户信息	UserDTO
accountExpireTime	账号失效时间	string(date-time)
activateToken	激活token	string
avatar	头像	string
createTime	创建时间	string(date-time)
creator	创建用户	string
customerId	客户ID	string
email	邮箱	string
enabled	账号状态	boolean
hasPassword	是否已重置密码	boolean
id	ID	string
level	角色级别：0：超级管理员；1：平台管理员 2：租户账号 3：租户下的账号	integer(int32)
organizationIds	所辖组织ids	array
password	密码	string
phoneNumber	电话号码	string
realName	真实名称	string
remark	备注	string
roleIds	角色ids	array
roles	角色信息列表	array
roleId	角色ID	string
roleName	角色名称	string
tbUser	TB的UserId	string
tenantId	租户ID	string
tenantName	租户名称	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
userStatusEnum	用户状态,可用值:DISABLED,EXPIRED,NORMAL	string
username	用户名	string

响应示例:

{
	"createTime": "",
	"creator": "",
	"defaultConfig": "",
	"description": "",
	"enabled": false,
	"icon": "",
	"id": "",
	"name": "",
	"noticeId": "",
	"readDate": "",
	"readStatus": "",
	"receiverId": "",
	"receiverName": "",
	"roleIds": [],
	"senderName": "",
	"sysNotice": {
		"avatar": "",
		"content": "",
		"createTime": "",
		"creator": "",
		"defaultConfig": "",
		"description": "",
		"enabled": false,
		"icon": "",
		"id": "",
		"name": "",
		"pointId": "",
		"receiverType": 0,
		"roleIds": [],
		"senderDate": "",
		"senderName": "",
		"status": 0,
		"tenantExpireTime": "",
		"tenantId": "",
		"tenantProfileId": "",
		"tenantStatus": "",
		"title": "",
		"type": "",
		"updateTime": "",
		"updater": ""
	},
	"tenantExpireTime": "",
	"tenantId": "",
	"tenantProfileId": "",
	"tenantStatus": "",
	"type": "",
	"updateTime": "",
	"updater": "",
	"user": {
		"accountExpireTime": "",
		"activateToken": "",
		"avatar": "",
		"createTime": "",
		"creator": "",
		"customerId": "",
		"email": "",
		"enabled": false,
		"hasPassword": false,
		"id": "",
		"level": 0,
		"organizationIds": [],
		"password": "",
		"phoneNumber": "",
		"realName": "",
		"remark": "",
		"roleIds": [],
		"roles": [
			{
				"roleId": "",
				"roleName": ""
			}
		],
		"tbUser": "",
		"tenantId": "",
		"tenantName": "",
		"updateTime": "",
		"updater": "",
		"userStatusEnum": "",
		"username": ""
	}
}