通知模版

1// Request
2
3{
4    // 用户组名称
5    "name" : "test",
6    "pageNo" : 1,
7    "pageSize" : 5
8}
9
10// Response
11{
12    "success": true,
13    "status": 200,
14    "page": {
15        "orderBy": "",
16        "order": "",
17        "pageNo": 1,
18        "pageSize": 5,
19        "totalCount": 29,
20        "result": [
21            {
22                // 用户组id，唯一标示，创建/更新通知模版时会用到
23                "id": "901e63af4e044f698c6863b1f2******",
24                "domainId": "453bf9588c9e488f9ba2c98412******",
25                // 用户组名称
26                "name": "luzhuopei_test",
27                // 用户组描述
28                "description": ""
29            },
30            {
31                "id": "4c5c086f66a9447ebfc6732909******",
32                "domainId": "453bf9588c9e488f9ba2c98412******",
33                "name": "new_test_20121",
34                "description": "update group"
35            },
36            {
37                "id": "0d291e2214ef48a19f59a0435a******",
38                "domainId": "453bf9588c9e488f9ba2c98412******",
39                "name": "new_test_238630",
40                "description": "update group"
41            },
42            {
43                "id": "0dcc6d8c92e04edcad700eda37******",
44                "domainId": "453bf9588c9e488f9ba2c98412******",
45                "name": "new_test_241148",
46                "description": "update group"
47            },
48            {
49                "id": "64b3d253226b4ef2b9949c0481******",
50                "domainId": "453bf9588c9e488f9ba2c98412******",
51                "name": "new_test_278381",
52                "description": "update group"
53            }
54        ]
55    }
56}

1// Request
2{
3    "name" : "test",
4    "pageNo" : 1,
5    "pageSize" : 3
6}
7
8// Response
9{
10    "success": true,
11    "status": 200,
12    "page": {
13        "orderBy": "",
14        "order": "",
15        "pageNo": 1,
16        "pageSize": 3,
17        "totalCount": 10,
18        "result": [
19            {
20                 // 用户唯一id，创建/更新模版时会用到
21                "id": "1fe098754e854a98ba29b642b7******",
22                "domainId": "453bf9588c9e488f9ba2c98412******",
23                // 用户名称
24                "name": "zmq-test-0704",
25                // 用户邮箱（脱敏展示）
26                "email": "",
27                // 用户电话（脱敏展示）
28                "phone": "*******2345",
29                "type": "identity"
30            },
31            {
32                "id": "5eeeb65c67de4f51b21a80c88e******",
33                "domainId": "453bf9588c9e488f9ba2c98412******",
34                "name": "testquota",
35                "email": "",
36                "phone": "",
37                "type": "identity"
38            },
39            {
40                "id": "dc7001a11f91451ea85c9cfdfc******",
41                "domainId": "453bf9588c9e488f9ba2c98412******",
42                "name": "test_lh",
43                "email": "",
44                "phone": "",
45                "type": "identity"
46            }
47        ]
48    }
49}

1POST    /csm/api/v1/userId/453bf9588c9e488f9ba2c98412******/action/create
2{
3    // 通知方式：EMAIL（邮件）、SMS（短信）、PHONE（电话
4    "notifications":[
5        {
6            "type":"EMAIL",
7            "receiver":""
8        },
9        {
10            "type":"SMS",
11            "receiver":""
12        },
13        {
14            "type":"PHONE",
15            "receiver":""
16        }
17    ],
18    // 通知人：用户和用户组二选一
19    "members":[
20        {
21            // 通知人类型：notifyGroup(用户组)、notifyParty(用户)
22            "type":"notifyParty",
23            // 通知人唯一id
24            "id":"56c9e0e2138c4f2ea5c9b6a876******",
25            // 通知人名称
26            "name":"lizhan"
27        },
28        {
29            "type":"notifyParty",
30            "id":"78575b75611c493e843af65469******",
31            "name":"gongjia"
32        }
33    ],
34    // 模版名称
35    "alias":"test_wjr",
36    // 定时关闭
37    // 如果不设置定时关闭则这是from和to 同时为00:00:00
38    // 可以设置需要再某个时间段关闭，比如00:00:00-01:00:00
39    "disableTimes":[
40        {
41            "from":"08:00:00",
42            "to":"00:00:05"
43        }
44    ],
45    // 报警回调
46    "actionCallBacks":[
47        {
48            // 回调地址
49            "url":"http://apiin.im.baidu.com/api/msg/groupmsgsend?access_token=d9d82f364e4be38aab243f788********",
50        }
51    ]
52}

1DELETE    /csm/api/v1/userId/453bf9588c9e488f9ba2c98412******/action/delete?name=c9e70d56-e030-475e-9031-926de7******

1// Request
2POST /csm/api/v1/userId/453bf9588c9e488f9ba2c98412******/action/actionList
3
4{
5    "name" : "tes",
6    "pageNo" : 1,
7    "pageSize" : 2,
8    "orderBy" : "lastModifiedDate",
9    "order" : "desc"
10}
11
12// Response
13{
14    "requestId": "ed5834bc-39ab-409e-a535-01b8fdc9d555",
15    "message": "",
16    "success": true,
17    "code": 200
18    "result": {
19        "orderBy": "lastModifiedDate",
20        "order": "desc",
21        "pageNo": 1,
22        "pageSize": 2,
23        "totalCount": 8,
24        "result": [
25            {
26                // 主用户id
27                "productName": "453bf9588c9e488f9ba2c98412******",
28                // 通知模版唯一标示
29                "name": "bd820c9c-89ec-4803-8bf0-b237ae******",
30                // 模版名称
31                "alias": "tes_action",
32                "source": "USER",
33                "type": "group",
34                // 定时关闭开始与结束时间
35                "disableTimes": [
36                    {
37                        "from": "00:05:00",
38                        "to": "00:06:00"
39                    }
40                ],
41                "notifications": [
42                    {
43                        // 通知模版唯一标示
44                        "receiver": "bd820c9c-89ec-4803-8bf0-b237ae******",
45                        // 通知渠道，取值（EMAIL、PHONE、SMS），代表（邮件、电话、短信）
46                        "type": "PHONE"
47                    },
48                    {
49                        "receiver": "bd820c9c-89ec-4803-8bf0-b237ae******",
50                        "type": "EMAIL"
51                    },
52                    {
53                        "receiver": "bd820c9c-89ec-4803-8bf0-b237ae******",
54                        "type": "SMS"
55                    }
56                ],
57                // 报警回调
58                "actionCallBacks": [
59                    {
60                        // 报警回调地址
61                        "url": "http://apiin.im.baidu.com/api/msg/groupmsgsend?access_token=d41f256ca8930904aa9a48c3a4d******"
62                    }
63                ],
64                // 通知人：用户和用户组二选一
65                "members": [
66                    {
67                        // 通知人类型：notifyGroup(用户组)、notifyParty(用户)
68                        "type": "notifyGroup",
69                        // 通知人唯一标示
70                        "id": "901e63af4e044f698c6863b1f2******",
71                        // 通知人名称
72                        "name": "luzhuopei_test"
73                    },
74                    {
75                        "type": "notifyGroup",
76                        "id": "ea20db42f34f4dca8d0ed476d9******",
77                        "name": "test_wjr_0505"
78                    }
79                ],
80                // 若通知人为用户，展示用户信息
81                "userInfos": [],
82                 // 若通知人为用户组，展示用户组信息
83                "groupInfos": {
84                    "901e63af4e044f698c6863b1f2******": [
85                        {
86                            "name": "luzhuo",
87                            "email": "lu******i@baidu.com",
88                            "phone": "*******1267",
89                            "type": "notifyparty"
90                        }
91                    ],
92                    "ea20db42f34f4dca8d0ed476d9******": [
93                        {
94                            "name": "zhaoming",
95                            "email": "zh*********n@baidu.com",
96                            "phone": "*******1899",
97                            "type": "notifyparty"
98                        }
99                    ]
100                },
101                "lastModifiedDate": "2023-11-28T06:21:55.000+0000"
102            },
103            {
104                "productName": "453bf9588c9e488f9ba2c98412******",
105                "name": "0cff004b-cde0-4cb4-8b7d-0fe311******",
106                "alias": "zsli_test",
107                "source": "USER",
108                "type": "user",
109                "disableTimes": [
110                    {
111                        "from": "00:00:00",
112                        "to": "00:00:00"
113                    }
114                ],
115                "notifications": [
116                    {
117                        "receiver": "0cff004b-cde0-4cb4-8b7d-0fe311******",
118                        "type": "EMAIL"
119                    },
120                    {
121                        "receiver": "0cff004b-cde0-4cb4-8b7d-0fe311******",
122                        "type": "SMS"
123                    }
124                ],
125                "actionCallBacks": [],
126                "members": [
127                    {
128                        "type": "notifyParty",
129                        "id": "56c9e0e2138c4f2ea5c9b6a876******",
130                        "name": "lizhanshi"
131                    }
132                ],
133                "userInfos": [
134                    {
135                        "name": "lizha",
136                        "email": "li******i@baidu.com",
137                        "phone": "*******1892",
138                        "type": "notifyparty"
139                    }
140                ],
141                "groupInfos": {},
142                "lastModifiedDate": "2023-11-22T15:31:41.000+0000"
143            }
144        ]
145    }
146}

1POST /csm/api/v1/userId/453bf9588c9e488f9ba2c98412******/action/update
2{
3      // 通知模版唯一标示，可从通知模版列表处获得
4      "name": "d358696a-b60b-4a02-a6fe-c8867080251c",
5      // 通知方式：EMAIL（邮件）、SMS（短信）、PHONE（电话）
6      "notifications": [
7            {
8                  "type": "EMAIL",
9                  "receiver": ""
10            },
11            {
12                  "type": "SMS",
13                  "receiver": ""
14            },
15            {
16                  "type": "PHONE",
17                  "receiver": ""
18            }
19      ],
20      // 通知人：用户和用户组二选一
21      "members": [
22            {
23                  // 通知人类型：notifyGroup(用户组)、notifyParty(用户)
24                  "type": "notifyParty",
25                  // 通知人唯一id
26                  "id": "b4af509ca1d2447b99475ae1dd******",
27                  // 通知人名称
28                  "name": "pyy"
29            }
30      ],
31      // 模版名称
32      "alias": "test",
33      "name": "",
34      // 定时关闭
35      // 如果不设置定时关闭则这是from和to 同时为00:00:00
36      // 可以设置需要再某个时间段关闭，比如00:00:00-01:00:00
37      "disableTimes": [
38            {
39                  "from": "00:00:00",
40                  "to": "06:00:00"
41            }
42      ],
43      // 报警回调
44      "actionCallBacks": [
45            {
46                  // 回调地址
47                  "url": "http://test.com/callback"
48            }
49      ],
50      "userId": "453bf9588c9e488f9ba2c98412******"
51}