SMS Gateway 用の API

アクションおよび状態変数を IBM Watson™ Assistant サービスと交換することで、SMS Gateway の動作および SMS セッションのフローを制御できます。 アクション・タグは、会話セッション中に SMS Gateway が実行するアクションを開始します。状態変数は、セッションの特性を示すために SMS Gateway によって送信されます。

アクション・タグ

SMS Gateway でアクションを開始するには、JSON フォーマットで Watson Assistant ダイアログ・ノードの output プロパティーにアクション・タグを定義します。 各アクションでは、smsAction プロパティーを定義します。このプロパティーには、command プロパティーとオプションの parameter プロパティーという 2 つの部分が含まれます。後者では、必要とされるコマンドの属性を定義できます。

例えば、以下のアクションが含まれたノードがトリガーされると、セッション・タイムアウトが 200 秒に設定されます。

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

smsActSendMedia が含まれたノードがトリガーされると、MMS メッセージングが有効にされます。

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

以下の表は、Watson Assistant ダイアログで指定できるアクションと、各アクションに定義可能な属性をリストしています。

SMS Gateway によって送信される状態変数

SMS セッションの状態の変更を示すために、SMS Gateway は、Watson Assistant にメッセージ要求ごとにコンテキスト変数を送信します。 Watson Assistant　ダイアログはステートレスであるため、Watson Assistant との交換のすべての状態は SMS Gateway 側で保持されます。 したがって、チャット・セッション内の Watson Assistant ターンごとに、context セクションが Watson Assistant に渡され、ダイアログによって処理または更新され、Watson Assistant から戻されます。

例えば、必須の値のみを使用する SMS セッションにおける基本的なターンでは、SMS Gateway は以下の context オブジェクトを送信します。

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

以下の状態変数が SMS Gateway からメッセージ要求で送信されます。 smsTenantPhoneNumber、smsUserPhoneNumber、smsUserData、および smsSessionTimeoutCount の値は、セッション REST API から直接プルされます。

テキスト・キーワード

特定のイベントは、SMS Gateway が Watson Assistant にメッセージ要求でテキスト・キーワードを送信するようにトリガーします。 このようなテキスト・キーワードを使用して、さらにサービス・オーケストレーション・エンジンで処理を行ったり、分析したりすることができます。

以下の表では、SMS Gateway から送信されるそのテキスト値と、それをトリガーするイベントをリストします。

Watson Assistant ダイアログで設定される変数

SMS Gateway の動作を変更するために、Watson Assistant ダイアログ内で以下の状態変数を設定できます。 関連する構成環境変数を持つ変数が設定されていない場合、その関連する環境変数の値が使用されます。