Référence de l’API Règles de routage

Valeurs possibles des champs

Type d’action

Valeur	Description
`NOTIFY_TEAM`	Notifier une équipe précise
`NOTIFY_WORKSPACE_MEMBER`	Notifier un membre précis de l’espace de travail
`NOTIFY_CURRENT_ON_CALL_USER`	Notifier la personne d’astreinte actuelle
`NOTIFY_NEXT_ON_CALL_USER`	Notifier la prochaine personne d’astreinte
`NOTIFY_ALL_ON_CALL_MEMBERS`	Notifier tous les membres actuellement d’astreinte

Type d’assertion

Valeur	Description
`IMPACT`	Vérifie l’impact d’un événement
`TITLE`	Vérifie le titre d’un événement
`DESCRIPTION`	Vérifie la description d’un événement
`AFFECTED_COMPONENTS`	Vérifie les composants affectés par un événement

Types de comparaison

Valeur	Description
`EQUALS`	Vérifie si la valeur est égale
`NOT_EQUALS`	Vérifie si la valeur n’est pas égale
`IS_EMPTY`	Vérifie si la valeur est vide
`NOT_EMPTY`	Vérifie si la valeur n’est pas vide
`GREATER_THAN`	Vérifie si la valeur est supérieure
`GREATER_THAN_OR_EQUALS`	Vérifie si la valeur est supérieure ou égale
`LESS_THAN`	Vérifie si la valeur est inférieure
`LESS_THAN_OR_EQUALS`	Vérifie si la valeur est inférieure ou égale
`CONTAINS`	Vérifie si la valeur contient une sous-chaîne donnée
`NOT_CONTAINS`	Vérifie si la valeur ne contient pas une sous-chaîne
`HAS_KEY`	Vérifie si un objet possède une clé donnée
`NOT_HAS_KEY`	Vérifie si un objet ne possède pas une clé donnée
`HAS_VALUE`	Vérifie si un objet possède une valeur donnée
`NOT_HAS_VALUE`	Vérifie si un objet ne possède pas une valeur donnée
`IS_NULL`	Vérifie si la valeur est nulle
`NOT_NULL`	Vérifie si la valeur n’est pas nulle
`STARTS_WITH`	Vérifie si la valeur commence par une sous-chaîne donnée
`ENDS_WITH`	Vérifie si la valeur se termine par une sous-chaîne donnée

Récupérer les règles de routage

Point de terminaison :

GET /:page_id/routing-rules

Exemple de requête

GET /1/routing-rules

Exemple de réponse

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

Créer une règle de routage

Point de terminaison :

POST /routing-rules

Notez que dans les actions, targetId peut être l’e-mail d’un membre de l’espace de travail ou l’ID d’une équipe, selon le type d’action.

Exemple de requête

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

Exemple de réponse

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

Mettre à jour une règle de routage

Point de terminaison :

PUT /routing-rules/:id

Exemple de requête

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

Exemple de réponse

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

Supprimer une règle de routage

Point de terminaison :

DELETE /routing-rules/:id

Exemple de requête

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

Exemple de réponse

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