Notification Template

1// Request
2{
3 // Group Name
4    "name" : "test",
5    "pageNo" : 1,
6    "pageSize" : 5
7}
8// Response
9{
10    "success": true,
11    "status": 200,
12    "page": {
13        "orderBy": "",
14        "order": "",
15        "pageNo": 1,
16        "pageSize": 5,
17        "totalCount": 29,
18        "result": [
19            {
20 // Group ID, unique identifier, used when creating/updating Notification Templates
21                "id": "901e63af4e044f698c6863b1f2******",
22                "domainId": "453bf9588c9e488f9ba2c98412******",
23 // Group Name
24                "name": "luzhuopei_test",
25 // Group description
26                "description": ""
27            },
28            {
29                "id": "4c5c086f66a9447ebfc6732909******",
30                "domainId": "453bf9588c9e488f9ba2c98412******",
31                "name": "new_test_20121",
32                "description": "update group"
33            },
34            {
35                "id": "0d291e2214ef48a19f59a0435a******",
36                "domainId": "453bf9588c9e488f9ba2c98412******",
37                "name": "new_test_238630",
38                "description": "update group"
39            },
40            {
41                "id": "0dcc6d8c92e04edcad700eda37******",
42                "domainId": "453bf9588c9e488f9ba2c98412******",
43                "name": "new_test_241148",
44                "description": "update group"
45            },
46            {
47                "id": "64b3d253226b4ef2b9949c0481******",
48                "domainId": "453bf9588c9e488f9ba2c98412******",
49                "name": "new_test_278381",
50                "description": "update group"
51            }
52        ]
53    }
54}

1// Request
2{
3    "name" : "test",
4    "pageNo" : 1,
5    "pageSize" : 3
6}
7// Response
8{
9    "success": true,
10    "status": 200,
11    "page": {
12        "orderBy": "",
13        "order": "",
14        "pageNo": 1,
15        "pageSize": 3,
16        "totalCount": 10,
17        "result": [
18            {
19 // Unique ID of the user, used when creating/updating templates
20                "id": "1fe098754e854a98ba29b642b7******",
21                "domainId": "453bf9588c9e488f9ba2c98412******",
22 // Username
23                "name": "zmq-test-0704",
24 // User email (desensitization display)
25                "email": "",
26 // User phone (desensitized display)
27                "phone": "*******2345",
28                "type": "identity"
29            },
30            {
31                "id": "5eeeb65c67de4f51b21a80c88e******",
32                "domainId": "453bf9588c9e488f9ba2c98412******",
33                "name": "testquota",
34                "email": "",
35                "phone": "",
36                "type": "identity"
37            },
38            {
39                "id": "dc7001a11f91451ea85c9cfdfc******",
40                "domainId": "453bf9588c9e488f9ba2c98412******",
41                "name": "test_lh",
42                "email": "",
43                "phone": "",
44                "type": "identity"
45            }
46        ]
47    }
48}

1POST    /csm/api/v1/userId/453bf9588c9e488f9ba2c98412******/action/create
2{
3 // Notification methods: 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 // Notifier: Choose between user and group
19    "members":[
20        {
21 // Notifier type: notifyGroup (group), notifyParty (user)
22            "type":"notifyParty",
23 // Unique ID of the notifier
24            "id":"56c9e0e2138c4f2ea5c9b6a876******",
25 // Notifier name
26            "name":"lizhan"
27        },
28        {
29            "type":"notifyParty",
30            "id":"78575b75611c493e843af65469******",
31            "name":"gongjia"
32        }
33    ],
34 // Template name
35    "alias":"test_wjr",
36 // Scheduled shutdown
37 // If scheduled shutdown is not configured, both ‘from’ and ‘to’ times will be default to 00:00:00
38 // You can configure to shut down during specific time periods, e.g., 00:00:00-01:00:00
39    "disableTimes":[
40        {
41            "from":"08:00:00",
42            "to":"00:00:05"
43        }
44    ],
45 // Alarm callback
46    "actionCallBacks":[
47        {
48 // Callback URL
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    "name" : "tes",
5    "pageNo" : 1,
6    "pageSize" : 2,
7    "orderBy" : "lastModifiedDate",
8    "order" : "desc"
9}
10// Response
11{
12    "requestId": "ed5834bc-39ab-409e-a535-01b8fdc9d555",
13    "message": "",
14    "success": true,
15    "code": 200
16    "result": {
17        "orderBy": "lastModifiedDate",
18        "order": "desc",
19        "pageNo": 1,
20        "pageSize": 2,
21        "totalCount": 8,
22        "result": [
23            {
24 // Primary user ID
25                "productName": "453bf9588c9e488f9ba2c98412******",
26 // Unique identifier of the Notification Template
27                "name": "bd820c9c-89ec-4803-8bf0-b237ae******",
28 // Template name
29                "alias": "tes_action",
30                "source": "USER",
31                "type": "group",
32 // Scheduled shutdown start and end time
33                "disableTimes": [
34                    {
35                        "from": "00:05:00",
36                        "to": "00:06:00"
37                    }
38                ],
39                "notifications": [
40                    {
41 // Unique identifier of the Notification Template
42                        "receiver": "bd820c9c-89ec-4803-8bf0-b237ae******",
43 // Notification channel, values (EMAIL, PHONE, SMS), representing (email, phone, SMS)
44                        "type": "PHONE"
45                    },
46                    {
47                        "receiver": "bd820c9c-89ec-4803-8bf0-b237ae******",
48                        "type": "EMAIL"
49                    },
50                    {
51                        "receiver": "bd820c9c-89ec-4803-8bf0-b237ae******",
52                        "type": "SMS"
53                    }
54                ],
55 // Alarm callback
56                "actionCallBacks": [
57                    {
58 // Alarm callback URL
59                        "url": "http://apiin.im.baidu.com/api/msg/groupmsgsend?access_token=d41f256ca8930904aa9a48c3a4d******"
60                    }
61                ],
62 // Notifier: Choose between user and group
63                "members": [
64                    {
65 // Notifier type: notifyGroup (group), notifyParty (user)
66                        "type": "notifyGroup",
67 // Unique identifier of the notifier
68                        "id": "901e63af4e044f698c6863b1f2******",
69 // Notifier name
70                        "name": "luzhuopei_test"
71                    },
72                    {
73                        "type": "notifyGroup",
74                        "id": "ea20db42f34f4dca8d0ed476d9******",
75                        "name": "test_wjr_0505"
76                    }
77                ],
78 // If the notifier is a user, show user information
79                "userInfos": [],
80 // If the notifier is a group, show group information
81                "groupInfos": {
82                    "901e63af4e044f698c6863b1f2******": [
83                        {
84                            "name": "luzhuo",
85                            "email": "lu******i@baidu.com",
86                            "phone": "*******1267",
87                            "type": "notifyparty"
88                        }
89                    ],
90                    "ea20db42f34f4dca8d0ed476d9******": [
91                        {
92                            "name": "zhaoming",
93                            "email": "zh*********n@baidu.com",
94                            "phone": "*******1899",
95                            "type": "notifyparty"
96                        }
97                    ]
98                },
99                "lastModifiedDate": "2023-11-28T06:21:55.000+0000"
100            },
101            {
102                "productName": "453bf9588c9e488f9ba2c98412******",
103                "name": "0cff004b-cde0-4cb4-8b7d-0fe311******",
104                "alias": "zsli_test",
105                "source": "USER",
106                "type": "user",
107                "disableTimes": [
108                    {
109                        "from": "00:00:00",
110                        "to": "00:00:00"
111                    }
112                ],
113                "notifications": [
114                    {
115                        "receiver": "0cff004b-cde0-4cb4-8b7d-0fe311******",
116                        "type": "EMAIL"
117                    },
118                    {
119                        "receiver": "0cff004b-cde0-4cb4-8b7d-0fe311******",
120                        "type": "SMS"
121                    }
122                ],
123                "actionCallBacks": [],
124                "members": [
125                    {
126                        "type": "notifyParty",
127                        "id": "56c9e0e2138c4f2ea5c9b6a876******",
128                        "name": "lizhanshi"
129                    }
130                ],
131                "userInfos": [
132                    {
133                        "name": "lizha",
134                        "email": "li******i@baidu.com",
135                        "phone": "*******1892",
136                        "type": "notifyparty"
137                    }
138                ],
139                "groupInfos": {},
140                "lastModifiedDate": "2023-11-22T15:31:41.000+0000"
141            }
142        ]
143    }
144}

1POST /csm/api/v1/userId/453bf9588c9e488f9ba2c98412******/action/update
2{
3 // Unique identifier of the Notification Template, obtainable from the Notification Template list
4      "name": "d358696a-b60b-4a02-a6fe-c8867080251c",
5 // Notification methods: 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 // Notifier: Choose between user and group
21      "members": [
22            {
23 // Notifier type: notifyGroup (group), notifyParty (user)
24                  "type": "notifyParty",
25 // Unique ID of the notifier
26                  "id": "b4af509ca1d2447b99475ae1dd******",
27 // Notifier name
28                  "name": "pyy"
29            }
30      ],
31 // Template name
32      "alias": "test",
33      "name": "",
34 // Scheduled shutdown
35 // If scheduled shutdown is not configured, both ‘from’ and ‘to’ times will be default to 00:00:00
36 // You can configure to shut down during specific time periods, e.g., 00:00:00-01:00:00
37      "disableTimes": [
38            {
39                  "from": "00:00:00",
40                  "to": "06:00:00"
41            }
42      ],
43 // Alarm callback
44      "actionCallBacks": [
45            {
46 // Callback URL
47                  "url": "http://test.com/callback"
48            }
49      ],
50      "userId": "453bf9588c9e488f9ba2c98412******"
51}