⌘ K

مرجع 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

توجه داشته باشید که در actionها، targetId بسته به نوع اقدام می‌تواند ایمیل یک عضو فضای کاری یا شناسه یک تیم باشد.

نمونه درخواست

{
  "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."
}