SMS Gateway 的 API

您可以藉由與 IBM Watson™ Assistant 服務之間交換動作和狀態變數，來控制 SMS Gateway 行為和 SMS 階段作業的流程。動作標籤會起始 SMS Gateway 在交談階段作業期間要採取的動作，而 SMS Gateway 會傳送狀態變數，來指出階段作業的性質。

動作標籤

如果要在 SMS Gateway 中起始動作，您可以在 output 內容中以 JSON 格式，在 Watson Assistant 對話節點上定義動作標籤。對於每一個動作，請定義一個 smsAction 內容，這包含兩個部分：command 內容以及選用的 parameter 內容，用來定義屬性給需要屬性的指令。

舉例來說，當觸發一個含有下列動作的節點時，它會將階段作業逾時值設為 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 對話中設定的變數

您可以在 Watson Assistant 對話內設定下列狀態變數，來修改 SMS Gateway 行為。如果未設定具有相關配置環境變數的變數，則會使用相關環境變數中的值。