查询协作空间列表

查询当前用户可访问的协作空间列表，支持过滤条件。

POST /channel/list

查询协作空间列表

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/channel/list?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "p": 1,
  "limit": 20,
  "orderby": "created_at",
  "asc": false
}
'

import requests

url = "https://api.flashcat.cloud/channel/list?app_key="

payload = {
    "p": 1,
    "limit": 20,
    "orderby": "created_at",
    "asc": False
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({p: 1, limit: 20, orderby: 'created_at', asc: false})
};

fetch('https://api.flashcat.cloud/channel/list?app_key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flashcat.cloud/channel/list?app_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'p' => 1,
    'limit' => 20,
    'orderby' => 'created_at',
    'asc' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.flashcat.cloud/channel/list?app_key="

	payload := strings.NewReader("{\n  \"p\": 1,\n  \"limit\": 20,\n  \"orderby\": \"created_at\",\n  \"asc\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/channel/list?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"p\": 1,\n  \"limit\": 20,\n  \"orderby\": \"created_at\",\n  \"asc\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/channel/list?app_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"p\": 1,\n  \"limit\": 20,\n  \"orderby\": \"created_at\",\n  \"asc\": false\n}"

response = http.request(request)
puts response.read_body

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "total": 42,
    "has_next_page": true,
    "items": [
      {
        "channel_id": 1001,
        "channel_name": "Production Alerts",
        "status": "enabled"
      }
    ]
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InvalidParameter",
    "message": "The specified parameter is not valid."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "Unauthorized",
    "message": "You are unauthorized."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "RequestTooFrequently",
    "message": "Request too frequently."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InternalError",
    "message": "We encountered an internal error, and it has been reported. Please try again later."
  }
}

​

限制说明

项目	说明
速率限制	每个账户 1,000 次/分钟；50 次/秒
权限要求	无 —— 持有有效的 app_key 即可调用

授权

app_key · string · query · 必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证，请妥善保管。

请求体

application/json

p · integer

页码，从 1 开始。

必填范围: x >= 1

limit · integer · 默认值: 100

每页大小，未传时默认为 100。

必填范围: 1 <= x <= 100

orderby · enum<string>

排序字段。

可用选项: ranking, created_at, updated_at, channel_name, last_incident_at

asc · boolean

为 true 时升序排序。

is_my_managed · boolean

为 true 时仅返回当前用户可管理的协作空间。

is_my_starred · boolean

为 true 时仅返回当前用户收藏的协作空间，与 is_my_team 互斥。

is_brief · boolean

为 true 时仅返回简要字段（channel_id、channel_name、description、status）。

is_my_team · boolean

为 true 时仅返回当前用户所在团队持有的协作空间，与 is_my_starred 互斥。

team_ids · integer<int64>[]

按团队 ID 过滤。

query · string

按名称/描述的全文查询串。

channel_ids · integer<int64>[]

按指定协作空间 ID 过滤。

channel_name · string

协作空间名称精确匹配，优先级高于 query 的名称过滤。

响应

200

application/json

成功

成功响应结构。2xx 响应中 request_id 标识本次调用（同时出现在 Flashcat-Request-Id 响应头中），data 为接口业务 payload。失败响应使用不同结构，参见 ErrorResponse。

request_id · string · 必填

本次请求的唯一 ID，也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

每个接口自己的业务 payload，详见各接口的 200 响应 schema。

Show child attributes