路由規則 API 參考

欄位的可用值

動作類型

值	說明
NOTIFY_TEAM	通知特定團隊
NOTIFY_WORKSPACE_MEMBER	通知特定工作區成員
NOTIFY_CURRENT_ON_CALL_USER	通知目前的待命人員
NOTIFY_NEXT_ON_CALL_USER	通知下一位待命人員
NOTIFY_ALL_ON_CALL_MEMBERS	通知所有目前待命的成員

判斷類型

值	說明
IMPACT	判斷事件的影響
TITLE	判斷事件的標題
DESCRIPTION	判斷事件的說明
AFFECTED_COMPONENTS	判斷事件受影響的元件

比較類型

值	說明
EQUALS	檢查值是否相等
NOT_EQUALS	檢查值是否不相等
IS_EMPTY	檢查值是否為空
NOT_EMPTY	檢查值是否不為空
GREATER_THAN	檢查值是否大於
GREATER_THAN_OR_EQUALS	檢查值是否大於或等於
LESS_THAN	檢查值是否小於
LESS_THAN_OR_EQUALS	檢查值是否小於或等於
CONTAINS	檢查值是否包含指定的子字串
NOT_CONTAINS	檢查值是否不包含指定的子字串
HAS_KEY	檢查物件是否有特定的鍵
NOT_HAS_KEY	檢查物件是否沒有特定的鍵
HAS_VALUE	檢查物件是否有特定的值
NOT_HAS_VALUE	檢查物件是否沒有特定的值
IS_NULL	檢查值是否為 null
NOT_NULL	檢查值是否不為 null
STARTS_WITH	檢查值是否以特定子字串開頭
ENDS_WITH	檢查值是否以特定子字串結尾

取得路由規則

端點：

GET /:page_id/routing-rules

請求範例

GET /1/routing-rules

回應範例

{
  "routingRules": [
    {
      "id": "1",
      "siteId": "pageId",
      "assertions": [
        {
          "id": "1",
          "routingRuleId": "1",
          "type": "TITLE",
          "comparison": "CONTAINS",
          "value": "value1"
        },
        {
          "id": "2",
          "routingRuleId": "1",
          "type": "TITLE",
          "comparison": "CONTAINS",
          "value": "value2"
        }
      ],
      "actions": [
        {
          "id": "1",
          "routingRuleId": "1",
          "type": "NOTIFY_WORKSPACE_MEMBER",
          "targetId": "value1"
        },
        {
          "id": "2",
          "routingRuleId": "1",
          "type": "NOTIFY_WORKSPACE_MEMBER",
          "targetId": "member@platform.com"
        }
      ],
      "createdAt": "2021-09-29T00:00:00.000Z",
      "updatedAt": "2021-09-29T00:00:00.000Z",
      "order": 1
    }
  ]
}

建立路由規則

端點：

POST /routing-rules

請注意，在動作中 targetId 可能是工作區成員的電子郵件或團隊 ID，取決於動作的類型。

請求範例

{
  "routingRule": {
    "assertions": [
      {
        "id": "1",
        "routingRuleId": "1",
        "type": "TITLE",
        "comparison": "CONTAINS",
        "value": "value1"
      },
      {
        "id": "2",
        "routingRuleId": "1",
        "type": "TITLE",
        "comparison": "CONTAINS",
        "value": "value2"
      }
    ],
    "actions": [
      {
        "id": "1",
        "routingRuleId": "1",
        "type": "NOTIFY_WORKSPACE_MEMBER",
        "targetId": "member2@platform.com"
      },
      {
        "id": "2",
        "routingRuleId": "1",
        "type": "NOTIFY_WORKSPACE_MEMBER",
        "targetId": "member@platform.com"
      }
    ],
    "order": 1,
    "siteId": "site-id-1"
  },
  "message": "Routing rule updated successfully"
}

回應範例

{
  "routingRule": {
    "id": "routing-rule-id-1",
    "order": 1,
    "siteId": "site123",
    "updatedAt": "2021-09-01T12:00:00Z",
    "createdAt": "2021-09-01T12:00:00Z"
  },
  "message": "Routing rule created successfully."
}

更新路由規則

端點：

PUT /routing-rules/:id

請求範例

PUT /routing-rules/routing-rule-id-1

{
  "routingRule": {
    "id": "routing-rule-id-1",
    "assertions": [
      {
        "id": "assertion-id-1",
        "routingRuleId": "routing-rule-id-1",
        "comparison": "CONTAINS",
        "value": "Issue With X",
        "type": "TITLE"
      }
    ],
    "order": 1,
    "siteId": "site-id-1",
    "updatedAt": "2021-09-01T12:00:00Z",
    "createdAt": "2021-05-01T12:00:00Z"
  },
  "message": "Routing rule updated successfully"
}

回應範例

{
  "routingRule": {
    "id": "routing-rule-id-1",
    "assertions": [
      {
        "id": "assertion-id-1",
        "routingRuleId": "routing-rule-id-1",
        "comparison": "CONTAINS",
        "value": "Issue With X",
        "type": "TITLE"
      }
    ],
    "order": 1,
    "siteId": "site-id-1",
    "updatedAt": "2024-08-09T12:00:00Z",
    "createdAt": "2021-05-01T12:00:00Z"
  },
  "message": "Routing rule updated successfully"
}

刪除路由規則

端點：

DELETE /routing-rules/:id

請求範例

DELETE /routing-rules/routing-rule-id-1

回應範例

{
  "message": "Routing rule deleted successfully."
}