外部データ参照

2020-11-11
2021-10-26

概要

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": "SEARCH",
  "eventTime": "2020-10-16 14:00:00",
  "item_name": "部署",
  "data": [
    {
      "title": "日付",
      "value": "2020年10月29日"
    },
    {
      "title": "時間",
      "value": "12時48分"
    },
    {
      "title": "場所",
      "value": "東京駅"
    },
    {
      "title": "確認",
      "value": "はい"
    }
  ],
  "info": {
    userId: 123
  }
}

レスポンス

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

  • HTTPステータスコード：200
  • Content-Type：application/Json
  • 文字コード：UTF-8
名前型備考
typestringcarousel（固定値）
layoutstringbutton or image
actionsarraylayout 別の object（下記参照）

ボタン形式

最大データ件数: 100件

名前型備考
labelstringラベル
textstring値（データに反映）

item_name “部署” に対して検索した結果を返す例

{  
  "type": "carousel",
  "layout": "button",
  "actions": [
     {
       "label": "営業部",
       "text": "sales"
     },
     {
       "label": "開発部",
       "text": "development"
     }
   ]
}

下記旧フォーマットも互換はありますが上記新フォーマット推奨（互換期限: 2022年1月）

[
  "営業部",
  "開発部"
]

画像形式

最大データ件数: 10件

名前型備考
labelstringラベル
textstring値（データに反映可能）
uristring画像URI（データに反映可能）
{  
  "type": "carousel",
  "layout": "image",
  "actions": [
     {
       "label": "iPhone 12",
       "text": "iPhone12",
       "uri": "https://domain-example.jp/test/iphone12.png"
     },
     {
       "label": "iPhone 12 mini",
       "text": "iPhone12mini",
       "uri": "https://domain-example.jp/test/iphone12mini.png"
     }
   ]
}

画像について

  • 画像サイズ上限：1280 x 960
  • 画像ファイルサイズ上限：1MB/毎
  • 画像フォーマット：png
  • 画像URIプロトコル：https （httpは動作保証なし）

PAGE TOP