查询用户组列表
请求结构
- method:POST
- URL:/json-api/v1/alarm/notify/group/list
请求参数
名称 |
类型 |
描述 |
是否必须 |
参数位置 |
userId |
String |
用户ID |
是 |
RequestBody参数 |
pageNo |
int |
分页数 |
是 |
RequestBody参数 |
pageSize |
int |
分页大小 |
是 |
RequestBody参数 |
请求示例
{
"userId": "453bf9588c9e488f9ba2c984129090dc",
"pageNo": 1,
"pageSize": 10
}
Reponse:
{
"success": true,
"status": 200,
"page": {
"orderBy": "",
"order": "",
"pageNo": 1,
"pageSize": 10,
"totalCount": 99,
"result": [
{
"id": "faa5b850a7794cacab671af883e7d412",
"domainId": "453bf9588c9e488f9ba2c984129090dc",
"name": "013138",
"description": ""
},
{
"id": "93b0ca8a00b14e77ab58df79fd211385",
"domainId": "453bf9588c9e488f9ba2c984129090dc",
"name": "0zjx",
"description": ""
},
{
"id": "f5a157772d1f4d438dd7fe866056a818",
"domainId": "453bf9588c9e488f9ba2c984129090dc",
"name": "0zywGroup",
"description": "update group"
}
]
}
}
查询用户列表
请求结构
- method:POST
- URL:/json-api/v1/alarm/notify/party/list
请求参数
名称 |
类型 |
描述 |
是否必须 |
参数位置 |
userId |
String |
用户ID |
是 |
RequestBody参数 |
pageNo |
int |
分页数 |
是 |
RequestBody参数 |
pageSize |
int |
分页大小 |
是 |
RequestBody参数 |
请求示例
{
"userId": "453bf9588c9e488f9ba2c984129090dc",
"pageNo": 1,
"pageSize": 10
}
{
"success": true,
"status": 200,
"page": {
"orderBy": "",
"order": "",
"pageNo": 1,
"pageSize": 9999,
"totalCount": 79,
"result": [
{
"id": "1fe098754e854a98ba29b642b755ec32",
"domainId": "453bf9588c9e488f9ba2c984129090dc",
"name": "zmq-test-0704",
"email": "",
"phone": "*******2345",
"type": "identity"
},
{
"id": "e79d2f0ffd2b47cf96a87f6ef2a78da7",
"domainId": "453bf9588c9e488f9ba2c984129090dc",
"name": "yanyuyu",
"email": "ya****u@baidu.com",
"phone": "*******7701",
"type": "notifyparty"
},
{
"id": "5eeeb65c67de4f51b21a80c88e61bfd6",
"domainId": "453bf9588c9e488f9ba2c984129090dc",
"name": "testquota",
"email": "",
"phone": "",
"type": "identity"
}
]
}
}
新建通知模版
请求结构
- method:POST
- URL:/csm/api/v1/userId/{userId}/action/create
请求参数
请求示例
POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/action/create
{
"notifications": [
{
"type": "EMAIL",
"receiver": ""
},
{
"type": "SMS",
"receiver": ""
},
{
"type": "PHONE",
"receiver": ""
}
],
"members": [
{
"type": "notifyParty",
"id": "b4af509ca1d2447b99475ae1dd1b7c94",
"name": "pyy"
}
],
"alias": "test",
"name": "",
"disableTimes": [
{
"from": "00:00:00",
"to": "06:00:00"
}
],
"actionCallBacks": [
{
"url": "http://test.com/callback"
}
],
"userId": "453bf9588c9e488f9ba2c984129090dc"
}
{
"result": {},
"success": true
}
删除通知模版
请求结构
- method:DELETE
- URL:/csm/api/v1/userId/{userId}/action/create?name={name}
请求参数
名称 |
类型 |
描述 |
是否必须 |
参数位置 |
userId |
String |
用户ID |
是 |
Path参数 |
name |
String |
通知模版name(模版列表返回的name,唯一标示) |
是 |
Path参数 |
请求示例
DELETE /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/action/delete?name=c9e70d56-e030-475e-9031-926de7f80f5d
{
"result": {},
"success": true
}
查询通知模版列表
请求结构
- Method:POST
- URL:/csm/api/v1/userId/{userId}/action/actionList
请求参数
名称 |
类型 |
描述 |
是否必须 |
参数位置 |
userId |
String |
用户id |
是 |
Query参数 |
name |
String |
通知模版名称 |
是 |
RequestBody参数 |
pageNo |
int |
分页数 |
是 |
RequestBody参数 |
pageSite |
int |
分页大小 |
是 |
RequestBody参数 |
order |
String |
排序规则,默认:desc |
是 |
RequestBody参数 |
orderBy |
String |
按照某字段排序,默认:lastModifiedDate |
是 |
RequestBody参数 |
响应示例
/csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/action/actionList
{
"pageSize": 10,
"pageNo": 1,
"name": "",
"userId": "453bf9588c9e488f9ba2c984129090dc",
"order": "desc",
"orderBy": "lastModifiedDate"
}
{
"requestId": "057869d2-0952-426c-b98d-7ca6dbe482c2",
"message": "",
"success": true,
"result": {
"orderBy": "lastModifiedDate",
"order": "desc",
"pageNo": 1,
"pageSize": 10,
"totalCount": 2,
"result": [
{
"productName": "453bf9588c9e488f9ba2c984129090dc",
"name": "d358696a-b60b-4a02-a6fe-c8867080251c",
"alias": "pyy_test",
"source": "USER",
"type": "group",
"disableTimes": [
{
"from": "00:00:00",
"to": "03:00:00"
}
],
"notifications": [
{
"receiver": "d358696a-b60b-4a02-a6fe-c8867080251c",
"type": "SMS"
},
{
"receiver": "d358696a-b60b-4a02-a6fe-c8867080251c",
"type": "PHONE"
},
{
"receiver": "d358696a-b60b-4a02-a6fe-c8867080251c",
"type": "EMAIL"
}
],
"actionCallBacks": [
{
"url": "http://pyy.test.com"
}
],
"members": [
{
"type": "notifyGroup",
"id": "faa5b850a7794cacab671af883e7d412",
"name": "013138"
}
],
"userInfos": [],
"groupInfos": {
"faa5b850a7794cacab671af883e7d412": [
{
"name": "guanyanyan_read",
"email": "",
"phone": "*******1922",
"type": "identity"
},
{
"name": "aaaaaa",
"email": "",
"phone": "",
"type": "identity"
}
]
},
"lastModifiedDate": "2023-07-25T07:28:31.000+0000"
},
{
"productName": "453bf9588c9e488f9ba2c984129090dc",
"name": "5c66feeb-8ac6-4a56-8be9-a7fa81546b1c",
"alias": "test_zmq_0505",
"source": "USER",
"type": "group",
"disableTimes": [
{
"from": "00:00:00",
"to": "00:00:00"
}
],
"notifications": [
{
"receiver": "5c66feeb-8ac6-4a56-8be9-a7fa81546b1c",
"type": "SMS"
}
],
"actionCallBacks": [],
"members": [
{
"type": "notifyGroup",
"id": "ea20db42f34f4dca8d0ed476d9480d88",
"name": "test_wjr_0505"
}
],
"userInfos": [],
"groupInfos": {
"ea20db42f34f4dca8d0ed476d9480d88": [
{
"name": "zhaomingqian",
"email": "zh*********n@baidu.com",
"phone": "*******1899",
"type": "notifyparty"
}
]
},
"lastModifiedDate": "2023-07-22T04:07:01.000+0000"
}
]
},
"code": 200
}
编辑通知模版
请求结构
- Method:POST
- URL:/csm/api/v1/userId/{userId}/action/update
请求参数
名称 |
类型 |
描述 |
是否必须 |
参数位置 |
userId |
String |
用户ID |
是 |
Path参数 |
name |
String |
通知模版name(通知列表接口返回的name,唯一标示) |
是 |
Path参数 |
notifications |
List<ActionNotificationDto> |
通知方式 |
是 |
RequestBody参数 |
members |
List<MemberDto> |
接收人(用户/用户组,二选一) |
是 |
RequestBody参数 |
alias |
String |
模版名称 |
是 |
RequestBody参数 |
disableTimes |
List<ActionDisableTimeDto> |
定时关闭 |
是 |
RequestBody参数 |
actionCallBacks |
List<ActionCallBackDto> |
报警回调地址 |
是 |
RequestBody参数 |
响应示例
POST /csm/api/v1/userId/453bf9588c9e488f9ba2c984129090dc/action/update
{
"name": "d358696a-b60b-4a02-a6fe-c8867080251c",
"notifications": [
{
"type": "EMAIL",
"receiver": ""
},
{
"type": "SMS",
"receiver": ""
},
{
"type": "PHONE",
"receiver": ""
}
],
"members": [
{
"type": "notifyParty",
"id": "b4af509ca1d2447b99475ae1dd1b7c94",
"name": "pyy"
}
],
"alias": "test",
"name": "",
"disableTimes": [
{
"from": "00:00:00",
"to": "06:00:00"
}
],
"actionCallBacks": [
{
"url": "http://test.com/callback"
}
],
"userId": "453bf9588c9e488f9ba2c984129090dc"
}
{
"result": {},
"success": true
}
附录
ActionNotificationDto
名称 |
类型 |
描述 |
type |
String |
通知渠道,取值(EMAIL、PHONE、SMS),代表(邮件、电话、短信),必填 |
aliasName |
String |
报警策略展示名,必填 |
MemberDto
名称 |
类型 |
描述 |
type |
String |
通知对象,取值(notifyParty、notifyGroup)代表(用户、用户组),必填 |
id |
String |
用户(组)列表接口返回的id,必填 |
name |
String |
用户(组)列表接口返回的name,必填 |
ActionDisableTimeDto
名称 |
类型 |
描述 |
from |
String |
定时关闭开始时间,如果不配置定时关闭设置该值为00:00:00,必填 |
to |
String |
定时关闭开始时间,如果不配置定时关闭设置该值为00:00:00,必填 |
ActionCallBackDto
名称 |
类型 |
描述 |
name |
String |
报警回调地址,选填 |