按集成查询空间名称

• 该api仅支持通过共享集成的integration_key进行认证　。integration_key可以从集成详情获取，来自协作空间下的专属集成integration_key无法调用此api。
• 该api使用场景为监控工具通过集成key直接获取空间列表，在配置告警规则时筛选和指定空间，配置告警的目的推送空间，而无需在Flashduty配置路由规则，以此简化告警通知配置。
• 该api默认返回所有协作空间的名称，包括设置为私有的协作空间，请谨慎保存integration_key，防止泄露　。如果传入成员信息，将优先返回成员可见信息。

POST /channel/list-by-integration

按集成查询空间名称

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/channel/list-by-integration?integration_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "channel_ids": [
    123
  ],
  "member_id": 123,
  "member_name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "country_code": "<string>"
}
'

200

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

授权

integration_key · string · query · 必填

请求头

Content-Type · string

请求体

application/json

query · string

查询关键词。检索范围：空间名称和描述

channel_ids · integer[]

空间ID列表，当传入此值，将根据ID查询空间

member_id · integer

成员ID，当传入此值，且可以匹配到有效用户，系统将返回改成员可见的空间

member_name · string

成员名称，当传入此值，且可以匹配到有效用户，系统将返回改成员可见的空间

email · string

成员邮箱，需要满足邮箱格式。当传入此值，且可以匹配到有效用户，系统将返回改成员可见的空间

phone · string

成员手机号，需要配合country_code解析。当传入此值，且可以匹配到有效用户，系统将返回改成员可见的空间

country_code · string

成员国家码，配合成员手机号使用

响应

200 - application/json

error · object

显示 子属性

data · object

显示 子属性