空间列表 - Flashcat API

请求参数

Authorization

在 query 添加参数

app_key

示例：

app_key: ********************

Header 参数

Content-Type

string

可选

示例值:

application/json

Body 参数application/json

p

integer

页码，从1开始

可选

limit

integer

分页条数

可选

asc

boolean

是否升序

可选

orderby

enum<string>

排序依据

可选

枚举值:

created_atranking

query

string

查询关键词

可选

检索范围：空间名称和描述

team_id

integer

团队ID

可选

筛选此团队管理的空间

is_my_managed

boolean

我管理的

可选

筛选我是创建者、或管理团队成员的空间

is_my_starred

boolean

我收藏的

可选

筛选我个人收藏的空间

is_my_team

boolean

我团队的

可选

筛选我所在团队下属的空间

channel_ids

array[integer]

空间ID列表

可选

指定ID检索

is_brief

boolean

仅返回名称和ID信息

必需

指定此参数，系统将忽略p和limit参数，返回所有空间的信息

示例

{
  "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
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.flashcat.cloud/channel/list?app_key' \
--header 'Content-Type: application/json' \
--data-raw ''

返回响应

🟢200成功

application/json

Body

error

object

可选

code

string

必需

message

string

必需

data

object

可选

items

array[object (Channel) {13}]

channel条目

必需

has_next_page

boolean

是否有下一页

必需

total

integer

总条目数

必需

示例

{
  "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": {
          "is_disabled": true,
          "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
  }
}