按集成查询空间名称

POST

https://api.flashcat.cloud/channel/list-by-integration

最后修改时间：2025-01-15 12:28:40

该api仅支持通过共享集成的integration_key进行认证。integration_key可以从集成详情获取，来自协作空间下的专属集成integration_key无法调用此api。

该api使用场景为监控工具通过集成key直接获取空间列表，在配置告警规则时筛选和指定空间，配置告警的目的推送空间，而无需在Flashduty配置路由规则，以此简化告警通知配置。

该api默认返回所有协作空间的名称，包括设置为私有的协作空间，请谨慎保存integration_key，防止泄露。如果传入成员信息，将优先返回成员可见信息。

请求参数

Authorization

在 query 添加参数

integration_key

示例：

integration_key: ********************

Header 参数

Body 参数application/json

示例

返回响应

🟢200成功

application/json

Body

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.flashcat.cloud/channel/list-by-integration?integration_key=<api-key>' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2Nlc3NfdXVpZCI6IjVmZTgxOWRmLWQwYTEtNGZjZS1hYjU0LTQxNjU0MGMwOWM1MyIsImF1dGhvcml6ZWQiOnRydWUsImV4cCI6MTc3MzMyNjA4MSwibW9jayI6ZmFsc2UsInVzZXJfaWRlbnRpdHkiOiIyNDUxMDAyNzUxMTMxLTM3OTA5MjUzNzIxMzEifQ.ryz-6SBR_YXEVHaugytcZUB9qpFN9valzU5PL7clEZg' \
--header 'Content-Type: application/json' \
--data-raw '{
    "query": "string",
    "channel_ids": [
        0
    ],
    "member_id": 0,
    "member_name": "string",
    "email": "string",
    "phone": "string",
    "country_code": "string"
}'

响应示例

{
    "error": {
        "code": "string",
        "message": "string"
    },
    "data": {
        "items": [
            {
                "channel_id": 0,
                "channel_name": "string",
                "status": "enabled"
            }
        ],
        "total": 0
    }
}

修改于 2025-01-15 12:28:40

取消收藏

模板列表