外部データ設定

2022-04-01
2022-08-09

概要

SPALOアシスタントなどのチャットアプリで回答タイプ「外部データ設定」が呼ばれると、設定されたWebhook-URL宛てに呼び出された項目名やこれまで会話で収集した情報が通知されます。そのレスポンスにチャットアプリに自動で設定したい値を渡すと、チャットアプリ側に反映する事ができます。

リクエスト方式

  • HTTP Method:POST
  • Content-Type:application/Json
  • 文字コード:UTF-8
  • タイムアウト:5秒

検索オブジェクト

パラメータ内容
webhookKeystringWebhookのキー(固定値)。エンドポイント保護に利用します。
secretHashstringwebhook 毎の clientSecret の hash値(可変値)。エンドポイント保護に利用します。
eventstringイベント内容
eventTimestringイベント時刻
item_namestringWebhook通知時の検索項目名
dataarrayシナリオ項目の入力済み全データ(array内のデータ構造は以下を参照)
infoobjectSPALO情報

データパラメータ

下記の形式で、dataパラメータには入力済みのシナリオの項目名と入力値が項目毎に object として入ります(セル連携しない回答タイプを含む)

キー内容備考
titlestringシナリオ項目名
valuestring入力値(回答値)
idstringセル番地
typestring回答タイプ

インフォパラメータ

infoパラメータにはSPALO側の情報が object 形式で入ります

オブジェクトサンプル

項目名「クライアント」が入力された後に、回答タイプ「外部データ設定」で通知されるオブジェクトの例

※既にボットとの会話で収集されたデータがある場合、data内にデータが入ります。

{
  "webhookKey": "85126C79CBF9FE36BB9D05D0639C70C235C18D37",
  "secretHash": "$2y$10$ee1ZuZ6XSxEkzq9egVTLL.OlU7wb/WCgY0ORQyCZpfiDihoPH3rXj",
  "event": "DATASET",
  "eventTime": "2022-04-01 14:00:00",
  "item_name": "外部データ設定",
  "data": [
    {
      "title": "日付",
      "value": "2022年04月01日"
    },
    {
      "title": "クライアント",
      "value": "株式会社テスト"
    }
  ],
  "info": {
    "userId": 123,
    "userName": "田中 太郎"
  }
}

レスポンス

レスポンスには下記の形式でデータを返してください。

  • HTTPステータスコード:200
  • Content-Type:application/Json
  • 文字コード:UTF-8
名前備考
typestringdataset(固定値)
actionsarrayobject形式の項目と値 (下記参照)

最大データ件数: 100件

名前最大文字数備考
keystring50シナリオ項目名
valuestring50値(データに反映)

入力されたクライアントの住所をチャットアプリ側に反映させる場合の例

{  
  "type": "dataset",
  "actions": [
     {
       "key": "クライアント住所",
       "value": "東京都中央区銀座1-2-3-4-5"
     },
     {
       "key": "クライアント電話番号",
       "value": "03-9999-9999"
     }
   ]
}

PAGE TOP