Instructions relatives aux actions utilisées avec les règles appels sortants

Des considérations spéciales s’appliquent lors action de données de la définition appels sortants du schéma de réussite d’un qui renvoie les données à une règle.

Propriétés de sortie de nid

Lors de la construction de son contact de sortie (schéma de réussite), il est impératif d’imbriquer des propriétés lorsque cela est nécessaire. Si un champ de sortie de /exécuter est un objet complexe, la propriété correspondante du schéma doit être un schéma imbriqué et non une chaîne supposant une sortie « aplatie». Outbound utilise déjà ? flatten = true pour aplatir la sortie.

Exemple de propriété non imbriquée

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data.my data field": {
      "type": "string",
    }
  }
}

L’exemple ci-dessus spécifie un « champ de données action de données data.my» dans le schéma de réussite d’un. L’action résultante ne fonctionnera pas appels sortants si elle est utilisée par une action de données règle. L’arrivée ne sera pas en mesure de trouver le champ dans le /actions/’actionId’/exécuter réponse. Il sautera les appels avec comme résultat ININ-OUTBOUND-RULE-ERROR-SKIPPED.

Pour éviter ce problème, faites de “mon champ de données” une propriété imbriquée du champ “données” :

Exemple correctement imbriqué

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "my data field": {
          "type": "string"
        }
      }
    }
  }
}

En général, votre schéma de sortie doit avoir la même structure que les propriétés que vous souhaitez récupérer à partir de la demande / execute

Considérez cet objet simple et comment le schéma de sortie le renvoie :

Un objet simple

{
  "foo": {
    "bat": "bar"
  }
}

Schéma de sortie de l’objet simple

{
 "$schema": "http://json-schema.org/draft-04/schema#",
 "type": "object",
 "properties": {
   "foo": {
     "type": "string"
   }
 }
}

Pour rendre cela compatible avec Outbound, modifiez le schéma de sortie de l’objet simple pour imbriquer la propriété :

Objet simple correctement imbriqué

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "foo": {
      "type": "object",
      "properties": {
        "bat": {
          "type": "string"
        }
      }
    }
  }
}

Ce schéma retournera :

{
  "foo": {
    "bat": "bar"
  }
}

Champs obligatoires

Si votre action de données requiert des champs, cochez-les comme requis dans le schéma de réussite.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "required": [
    "contact_id",
    "phone_number"
  ],
  "properties": {
   ...
    },