Flashcat API (English)
API referenceDocs中文
API referenceDocs中文
  1. Channel
  • Open API
    • Quick Start
    • About Pagination
    • Member Management
      • Invite members
      • Delete member
      • Reset information
      • Member list
    • Team Management
      • Team list
      • Basic information
      • Delete team
      • Team upsert
    • Schedule Management
      • Preview schedule
      • Update schedule
      • Enable schedule
      • Disable schedule
      • Create schedule
      • Delete schedule
      • View schedule details
      • Get schedule information by ID list
      • View schedule list
      • Personal schedule calendar
      • Role information
    • Information Retrieval
      • Channel
      • Member
      • Team
    • Preference Settings
      • View preference settings
      • Modify preference settings
    • Channel
      • Escalation Rules
        • Enable rule
        • Disable rule
        • Delete rule
        • Rule list
        • Rule details
        • Create rule
        • Update rule
      • Subscription Rules
        • Enable rule
        • Disable rule
        • Delete rule
        • Rule list
        • Create rule
        • Update rule
      • Drop Rules
        • Enable rule
        • Disable rule
        • Delete rule
        • Rule list
        • Create rule
        • Update rule
      • Silence Rules
        • Enable rule
        • Disable rule
        • Delete rule
        • Rule list
        • Rule details
        • Inner conditions
      • Inhibit Rules
        • Disable rule
        • Delete rule
        • Rule list
        • See creation interface for filters explanation
        • Channel ID
        • Rule name
      • Match conditions
        POST
      • Delete rule
        POST
      • See creation interface for filters explanation
        POST
      • Enable rule
        POST
      • Update rule
        POST
      • Rule ID
        POST
      • Rule name
        POST
      • Sort
        POST
      • Delete rule
        POST
      • See creation interface for filters explanation
        POST
      • Name by integration
        POST
      • Robot list
        POST
    • Template Management
      • Name
      • Enable rule
      • Delete rule
      • See creation interface for filters explanation
      • Channel ID
      • Rule name
      • Required when updating
      • Update rule
    • Incident Management
      • Group View
        • Channel
        • Rule name
        • Inner conditions
        • Channel
      • Match conditions
      • Enable rule
      • Disable rule
      • Delete rule
      • Rule list
      • See creation interface for filters explanation
      • Create rule
      • Rule description
      • Update rule
      • Channel
      • Match conditions
      • Match conditions
      • Update rule
      • Channel
      • Rule ID
      • Inner conditions
      • Enable rule
      • Rule list
      • Rule details
      • Rule name
      • Rule description
      • Match conditions
      • Rule description
      • See creation interface for filters explanation
      • Disable rule
      • Rule description
    • Alert Management
      • Group View
        • Required when updating
        • Rule name
        • Inner conditions
        • Disable rule
      • Alert Info
      • Close Alert
      • Alert List By Card
      • Alert List
      • Alert List By ID
      • Event List
      • Feed
      • Merge Incident
    • Change Management
      • Inner conditions
    • Insights (old)
      • Channel
      • Match conditions
      • Rule ID
      • Enable rule
      • Name
      • Disable rule
      • Rule name
      • Name
      • See creation interface for filters explanation
    • Custom Fields
      • Enable rule
      • Disable rule
      • See creation interface for filters explanation
      • Channel ID
      • Channel
    • Service Calendar
      • Match conditions
      • Delete rule
      • Update rule
      • Required when updating
      • Rule details
      • Required when updating
      • Inner conditions
      • Channel
    • Label Enhancement
      • Mapping
        • Rule name
        • Rule list
        • Rule description
        • Match conditions
        • Rule ID
        • Rule description
        • Inner conditions
        • Enable rule
        • Disable rule
        • Rule description
      • Enable rule
      • Delete rule
    • Alert Processing
      • Create rule
      • Rule name
    • Integration Routing
      • Required when updating
      • Rule description
      • Match conditions
    • License Management
      • Create rule
    • Insights
      • Team Metrics
      • Responder Metrics Export
      • Incident List
      • Responder Metrics
      • Account Metrics
      • Channel Metrics Export
      • Team Metrics Export
      • Incident Export
      • Alert Top
      • Cahnnel Metrics
  • Event API
    • Quick Start
    • Alert Event
    • Change Event
  • Webhook
    • Quick Start
    • Custom Actions
    • Alert Webhook
    • Incident Webhook
  1. Channel

See creation interface for filters explanation

POST
/channel/create

Request

Header Params
Content-Type
string 
optional
Example:
application/json
Body Params application/json
channel_name
string 
Create rule
required
description
string 
Channel
optional
team_id
integer 
Rule name
optional
Rule description
escalate_rule
object 
Update rule
optional
aggr_window
integer 
Inner conditions
optional
template_id
string 
Match conditions
required
target
object (EscalateTarget) 
Name
required
plugin_ids
array[integer]
Channel
optional
auto_resolve_timeout
integer 
Rule ID
optional
Required when updating
>= 0<= 86400
is_private
boolean 
Rule name
optional
Rule description
group
object (Group) 
Inner conditions
optional
method
enum<string> 
Rule ID
required
Allowed values:
ipn
cases
array[object (CaseEqual) {2}] 
Required when updating
optional
Rule name
<= 10 items
equals
array [array] 
Match conditions
optional
Name
<= 5 items
all_equals_required
boolean 
Enable rule
optional
Disable rule
time_window
integer 
Delete rule
optional
Rule list
storm_threshold
integer 
See creation interface for filters explanation
optional
Rule details
flapping
object (Flapping) 
Match conditions
optional
max_changes
enum<string> 
Create rule
required
Channel
Allowed values:
ipn
in_mins
integer 
Rule name
required
Rule description
mute_mins
integer 
Inner conditions
required
Match conditions
Example
{
    "channel_name": "string",
    "description": "string",
    "team_id": 0,
    "escalate_rule": {
        "aggr_window": 0,
        "template_id": "string",
        "target": {
            "team_ids": [
                0
            ],
            "person_ids": [
                0
            ],
            "schedule_to_role_ids": {
                "{schedule_id}": [
                    0
                ]
            },
            "by": {
                "follow_preference": true,
                "critical": [
                    "email"
                ],
                "warning": [
                    "email"
                ],
                "info": [
                    "email"
                ]
            },
            "webhooks": [
                {
                    "type": "feishu_app",
                    "settings": {}
                }
            ]
        }
    },
    "plugin_ids": [
        0
    ],
    "auto_resolve_timeout": 0,
    "is_private": true,
    "group": {
        "method": "i",
        "cases": [
            {
                "if": [
                    {
                        "key": "title",
                        "oper": "IN",
                        "vals": [
                            "string"
                        ]
                    }
                ],
                "equals": [
                    "string"
                ]
            }
        ],
        "equals": [
            [
                "title"
            ]
        ],
        "all_equals_required": true,
        "time_window": 0,
        "storm_threshold": 0
    },
    "flapping": {
        "max_changes": "i",
        "in_mins": 0,
        "mute_mins": 0
    }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://prod-cn.your-api-server.com/channel/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "channel_name": "string",
    "description": "string",
    "team_id": 0,
    "escalate_rule": {
        "aggr_window": 0,
        "template_id": "string",
        "target": {
            "team_ids": [
                0
            ],
            "person_ids": [
                0
            ],
            "schedule_to_role_ids": {
                "{schedule_id}": [
                    0
                ]
            },
            "by": {
                "follow_preference": true,
                "critical": [
                    "email"
                ],
                "warning": [
                    "email"
                ],
                "info": [
                    "email"
                ]
            },
            "webhooks": [
                {
                    "type": "feishu_app",
                    "settings": {}
                }
            ]
        }
    },
    "plugin_ids": [
        0
    ],
    "auto_resolve_timeout": 0,
    "is_private": true,
    "group": {
        "method": "i",
        "cases": [
            {
                "if": [
                    {
                        "key": "title",
                        "oper": "IN",
                        "vals": [
                            "string"
                        ]
                    }
                ],
                "equals": [
                    "string"
                ]
            }
        ],
        "equals": [
            [
                "title"
            ]
        ],
        "all_equals_required": true,
        "time_window": 0,
        "storm_threshold": 0
    },
    "flapping": {
        "max_changes": "i",
        "in_mins": 0,
        "mute_mins": 0
    }
}'

Responses

🟢200成功
application/json
Body
error
object (DutyError) 
optional
code
enum<string> 
Rule description
required
Allowed values:
InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist
message
string 
Inner conditions
required
data
object 
optional
channel_id
string 
ID
required
channel_name
string 
Name
required
Example
{
    "error": {
        "code": "InvalidParameter",
        "message": "string"
    },
    "data": {
        "channel_id": "string",
        "channel_name": "string"
    }
}
Modified at 2025-01-22 10:14:38
Previous
Delete rule
Next
Enable rule
Built with