API de SMS Gateway

Vous pouvez contrôler le comportement de SMS Gateway et le flux d'une session SMS en échangeant des actions et des variables d'état avec le service IBM Watson™ Assistant. Les balises d'action initient des actions que SMS Gateway effectue durant une session de conversation et des variables d'état sont envoyées par SMS Gateway pour indiquer les caractéristiques de la session.

Balises d'action

Pour initier des actions dans SMS Gateway, vous pouvez définir des balises d'action dans un noeud du dialogue Watson Assistant au format JSON sur la propriété output. Pour chaque action, définissez une propriété smsAction contenant deux parties : une propriété command et une propriété facultative parameter où vous pouvez définir des attributs pour les commandes qui en ont besoin.

Par exemple, lorsqu'un noeud contenant l'action suivante est déclenché, il définit le délai d'attente de session sur 200 secondes.

{
  "output": {
    "smsAction": {
      "command": "setSessionTimeoutCount",
      "parameters":{
            "count": 200
       }
    }
  }
}

Lorsqu'un noeud contenant smsActSendMedia est déclenché, la messagerie MMS est activée.

{
  "output": {
    "smsAction": {
          "command": "smsActSendMedia",
          "parameters":{
            "mediaURL": [
              "https://exampleonly.com/media/l4JyRqcDU93S334KQ/first.gif",
              "https://exampleonly.com/media/tK9wGsGc72LcznCSeU/second.gif"
            ]
         }  
      }
   }   
}

Le tableau suivant affiche une liste des actions que vous pouvez spécifier dans le dialogue Watson Assistant ainsi que les attributs que vous pouvez définir pour chaque action.

Variables d'état envoyées par SMS Gateway

Pour indiquer un changement d'état dans la session SMS, SMS Gateway envoie des variables contextuelles dans chaque demande de message adressée à Watson Assistant. Comme le dialogue Watson Assistant n'a pas d'état, tout état est conservé dans SMS Gateway entre les échanges avec Watson Assistant. Cela signifie que pour chaque échange de Watson Assistant au sein d'une discussion, la section context est transmise à Watson Assistant, traitée ou mise à jour par le dialogue puis reçue en retour par Watson Assistant.

Par exemple, pour un échange de base dans la session SMS utilisant uniquement les valeurs requises, SMS Gateway envoie l'objet context suivant.

{
  "context": {
    "smsTenantPhoneNumber": "+12345556789",
    "smsUserPhoneNumber": "+18765554321",
    "smsSessionID": "a23de67h-e527-40d5-a867-5c0ce9e72d0d"
  }
}

Les variables d'état suivantes sont envoyées par SMS Gateway dans la demande de message. Les valeurs smsTenantPhoneNumber, smsUserPhoneNumber, smsUserData et smsSessionTimeoutCount sont extraites directement de l'API REST de session.

Mots-clés du texte

Certains événements déclenchent l'envoi par SMS Gateway d'un mot-clé texte dans la demande de message envoyée à Watson Assistant. Vous pouvez utiliser ces mots-clés texte pour un traitement ultérieur dans un moteur d'orchestration de service ou une analyse.

Le tableau suivant répertorie la valeur texte exacte envoyée par SMS Gateway et l'événement qui la déclenche.

Variables définies dans le dialogue Watson Assistant

Vous pouvez définir les variables d'état suivantes dans le dialogue Watson Assistant pour modifier le comportement de SMS Gateway. Si une variable associée à une variable d'environnement de configuration n'est pas définie, la valeur de la variable d'environnement associée est utilisée.