跳转到主要内容
POST
/
channel
/
escalate
/
rule
/
create
创建分派策略
curl --request POST \
  --url 'https://api.flashcat.cloud/channel/escalate/rule/create?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel_id": 3521074710131,
  "rule_name": "On-call escalation",
  "template_id": "6321aad26c12104586a88916",
  "description": "Notify primary on-call, then escalate to secondary after 30 minutes",
  "layers": [
    {
      "target": {
        "person_ids": [
          3790925372131
        ],
        "by": {
          "follow_preference": true
        }
      },
      "max_times": 3,
      "notify_step": 10,
      "escalate_window": 30,
      "force_escalate": false
    }
  ]
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "rule_id": "69db2f72a0fe7db6448b1506",
    "rule_name": "Test escalation rule"
  }
}

限制说明

项目说明
速率限制每个账户 1,000 次/分钟50 次/秒
权限要求协作空间管理on-call

授权

app_key
string
query
必填

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

请求体

application/json

创建分派策略所需的参数。

channel_id
integer<int64>
必填

所属协作空间 ID。

template_id
string
必填

通知模板 ID(MongoDB ObjectID)。

Pattern: ^[0-9a-fA-F]{24}$
rule_name
string
必填

策略名称,1 到 39 个字符。

Required string length: 1 - 39
layers
object[]
必填

分派环节列表,至少包含一个环节。

priority
integer

匹配优先级,数值越小越优先。

必填范围: 0 <= x <= 200
aggr_window
integer

聚合窗口,单位秒,0 表示不聚合。

必填范围: 0 <= x <= 3600
description
string

策略描述,最多 500 个字符。

Maximum string length: 500
time_filters
object[]

可选的周期性生效时间窗口。

filters
object[][]

或-与组合条件树。每个外层元素为一组 AND 条件,组内所有条件需同时满足。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

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