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

Match conditions

POST
/channel/list
Name

Request

Header Params
Content-Type
string 
optional
Example:
application/json
Body Params application/json
p
integer 
Update rule
optional
limit
integer 
Channel
optional
asc
boolean 
Rule ID
optional
orderby
enum<string> 
Required when updating
optional
Allowed values:
created_atranking
query
string 
Rule name
optional
Rule description
team_id
integer 
Inner conditions
optional
Match conditions
is_my_managed
boolean 
Name
optional
Enable rule
is_my_starred
boolean 
Disable rule
optional
Delete rule
is_my_team
boolean 
Rule list
optional
See creation interface for filters explanation
channel_ids
array[integer]
Rule details
optional
Channel ID
is_brief
boolean 
Rule ID
required
Create rule
Example
{
    "p": 0,
    "limit": 0,
    "asc": true,
    "orderby": "created_at",
    "query": "string",
    "team_id": 0,
    "is_my_managed": true,
    "is_my_starred": true,
    "is_my_team": true,
    "channel_ids": [
        0
    ],
    "is_brief": true
}

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/list' \
--header 'Content-Type: application/json' \
--data-raw '{
    "p": 0,
    "limit": 0,
    "asc": true,
    "orderby": "created_at",
    "query": "string",
    "team_id": 0,
    "is_my_managed": true,
    "is_my_starred": true,
    "is_my_team": true,
    "channel_ids": [
        0
    ],
    "is_brief": true
}'

Responses

🟢200成功
application/json
Body
error
object 
optional
code
string 
required
message
string 
required
data
object 
optional
items
array[object (Channel) {13}] 
Channel
required
has_next_page
boolean 
Rule name
required
total
integer 
Rule description
required
Example
{
    "error": {
        "code": "string",
        "message": "string"
    },
    "data": {
        "items": [
            {
                "channel_id": 0,
                "team_id": 0,
                "channel_name": "string",
                "description": "string",
                "auto_resolve_timeout": 0,
                "is_private": true,
                "flapping": {
                    "max_changes": "i",
                    "in_mins": 0,
                    "mute_mins": 0
                },
                "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
                },
                "status": "enabled",
                "created_at": 0,
                "updated_at": 0,
                "progress_to_incident_cnts": {
                    "Triggered": 0,
                    "Processing": 0
                },
                "active_incident_highest_severity": "string"
            }
        ],
        "has_next_page": true,
        "total": 0
    }
}
Modified at 2025-01-22 10:14:38
Previous
Rule name
Next
Delete rule
Built with