1. API Description

Domain name for API request: cls.intl.tencentcloudapi.com.

This API is used to create a notification channel group with two configuration modes to choose from.

1. Easy mode provides the most basic notification channel function. The following parameters are required:

2. Type

3. NoticeReceivers

4. WebCallbacks

5. Advanced mode: On the basis of easy mode, it supports setting rules, setting notification channels for different types of alarms, and escalating alarms. The following parameters are required:

6. NoticeRules

A maximum of 20 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

3. Output Parameters

4. Example

Example1 Creating a Notification Channel Group (Easy Mode)

Includes two notification channels:
Use sms and phone to notify user Group (Group), user Group id is 27411.
Send notifications to the WeCom robot

Input Example

POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAlarmNotice
<Common request parameters>

{
    "Name": "demoAlarmNotice1",
    "Type": "All",
    "NoticeReceivers": [
        {
            "ReceiverType": "Group",
            "ReceiverIds": [
                27411
            ],
            "ReceiverChannels": [
                "Sms",
                "Phone"
            ],
            "StartTime": "00:00:00",
            "EndTime": "23:59:59",
            "NoticeContentId": "Default-zh",
            "Index": 1
        }
    ],
    "WebCallbacks": [
        {
            "Method": "POST",
            "CallbackType": "WeCom",
            "NoticeContentId": "Default-zh",
            "Url": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxx-xxxx-xxxx-xxxx-xxxx"
        }
    ],
    "NoticeRules": [],
    "DeliverStatus": 1,
    "AlarmShieldStatus": 2
}

Output Example

{
    "Response": {
        "AlarmNoticeId": "notice-b44d3a04-xxxx-4f9d-91f8-8abab903d885",
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
    }
}

Example2 Creating a Notification Channel Group (Advanced Mode)

It includes two processes: the alert first triggers notification process 1, and if unclaimed and unresolved after 10 minutes, it triggers notification process 2.
Step 1 includes 2 notification channels:
Use sms and phone to notify user Group (Group), user Group id is 27411.
Send notifications to the WeCom robot
Step 2 includes 1 notification channel

• Use sms and phone calls to notify the user group (Uin) with user id 6318337.

Input Example

POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAlarmNotice
<Common request parameters>

{
    "Name": "demoAlarmNotice2",
    "NoticeRules": [
        {
            "NoticeReceivers": [
                {
                    "ReceiverType": "Group",
                    "ReceiverIds": [
                        27411
                    ],
                    "ReceiverChannels": [
                        "Sms",
                        "Phone"
                    ],
                    "StartTime": "00:00:00",
                    "EndTime": "23:59:59",
                    "NoticeContentId": "Default-zh"
                }
            ],
            "WebCallbacks": [
                {
                    "Method": "POST",
                    "CallbackType": "WeCom",
                    "NoticeContentId": "Default-zh",
                    "Url": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxx-xxxx-xxxx-xxxx-xxxx"
                }
            ],
            "Escalate": true,
            "Type": 1,
            "Interval": 10,
            "EscalateNotice": {
                "NoticeReceivers": [
                    {
                        "ReceiverType": "Uin",
                        "ReceiverIds": [
                            6318337
                        ],
                        "ReceiverChannels": [
                            "Sms",
                            "Phone"
                        ],
                        "StartTime": "00:00:00",
                        "EndTime": "23:59:59",
                        "NoticeContentId": "Default-zh"
                    }
                ],
                "WebCallbacks": [],
                "Escalate": false
            },
            "Rule": "{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"NotifyType\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1,2]\",\"Type\":\"Value\"}]}]}"
        }
    ],
    "DeliverStatus": 1,
    "AlarmShieldStatus": 2
}

Output Example

{
    "Response": {
        "AlarmNoticeId": "notice-b44d3a04-xxxx-4f9d-91f8-8abab903d885",
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.