ChannelTimeRange configuration description

Configuration for the effective time of notification channels. Supports two modes: unified configuration and separate configuration.

Format

This field must be in JSON format and supports the following core properties:

Properties

sendChannel: Notification channel configuration (required)

• A required field that specifies the notification channels to be configured.
• Format: Multiple channels separated by commas, e.g., "sms,webhook,mail,phone".
• Supported channels: sms, webhook (e.g., DingTalk, WeCom), mail, and phone.

timezone: Time zone setting

• Supports GMT or UTC format.
• Example: GMT+8 or UTC+08:00.
• Note: The time zone determines the reference standard for the effective time of alerts and is independent of the actual geographical location. For example, if you are in the Beijing region but configure "New York Time Zone (UTC-4), Monday 00:00-03:00", the system will operate based on the local time in New York.

webhookIsAtAll: Webhook notification configuration

• The value is "true" or "false".
• Indicates whether to @all members in a Webhook notification.

timeRanges: Time range configuration (required)

• Supports two configuration modes:

  1. Unified Configuration: Use "all" as the key to set a single time period for all selected channels.
  2. Separate Configuration: Configure a time period for each channel individually, with the key being the specific channel identifier.

Time period configuration items

Each time period includes the following properties:

• startTime: The start time, in HH:mm format (required).
• endTime: The end time, in HH:mm format (required).
• daysOfWeek: The effective days of the week, in an array format. 1-7 represent Monday to Sunday (optional. If empty, this time period is not effective).

Example configurations

Example 1: Unified configuration mode

{
  "sendChannel": "sms,webhook,mail,phone",
  "timezone": "UTC+08:00",
  "webhookIsAtAll": "false",
  "timeRanges": {
    "all": [
      {
        "startTime": "08:00",
        "endTime": "18:00",
        "daysOfWeek": [1, 2, 3, 4, 5]
      }
    ]
  }
}

Example 2: Separate configuration mode

{
  "sendChannel": "sms,webhook,mail,phone",
  "timezone": "GMT+8",
  "webhookIsAtAll": "false",
  "timeRanges": {
    "webhook": [
      {
        "startTime": "08:00",
        "endTime": "18:00",
        "daysOfWeek": [1, 2, 3, 4, 5]
      }
    ],
    "sms": [
      {
        "startTime": "08:00",
        "endTime": "18:00",
        "daysOfWeek": [1, 2, 3, 4, 5]
      }
    ],
    "mail": [
      {
        "startTime": "08:00",
        "endTime": "18:00",
        "daysOfWeek": [1, 2, 3, 4, 5]
      }
    ],
    "phone": [
      {
        "startTime": "08:00",
        "endTime": "18:00",
        "daysOfWeek": [1, 2, 3, 4, 5]
      }
    ]
  }
}

Note

1. The sendChannel field is required and can only contain supported notification channels.
2. When timeRanges contains "all", it signifies the unified configuration mode. In this case, it cannot contain configurations for other individual channels.
3. When timeRanges does not contain "all", you need to configure each channel specified in sendChannel separately.
4. Time must use the 24-hour format (HH:mm).
5. Days of the week are represented by numbers from 1 to 7, corresponding to Monday through Sunday.
6. The time zone supports configuration in both GMT and UTC formats.