外部データ設定
2022-04-01
2023-03-06
概要
SPALOアシスタントなどのチャットアプリで回答タイプ「外部データ設定」が呼ばれると、設定されたWebhook-URL宛てに呼び出された項目名やこれまで会話で収集した情報が通知されます。そのレスポンスにチャットアプリに自動で設定したい値を渡すと、チャットアプリ側に反映する事ができます。
リクエスト
- HTTP Method：POST
- Content-Type：application/Json
- 文字コード：UTF-8
- タイムアウト：5秒
requestObject
| パラメータ | 型 | 内容 |
|---|---|---|
| webhookKey | string | Webhookのキー（固定値）。エンドポイント保護に利用します。 |
| secretHash | string | webhook 毎の clientSecret の hash値（可変値）。エンドポイント保護に利用します。 |
| event | string | dataset |
| eventTime | string | イベント時刻 |
| botName | string | ボット名 |
| item_name | string | Webhook通知時の検索項目名 |
| info | object | 送信者情報（下記参照） |
| data | array | セル連携のない回答タイプを含む入力済み全データ（下記参照） |
info
データ参照と共通
data
データ参照と共通
リクエストオブジェクト例
回答タイプ「外部データ設定」で通知されるオブジェクトの例
{
"webhookKey": "85126C79CBF9FE36BB9D05D0639C70C235C18D37",
"secretHash": "$2a$10$WOqE.sD38vWR5376P8DC7..fP/cnTefOVlymq1AVIEAqDkKJeWjT6",
"event": "DATASET",
"eventTime": "2023-01-18 09:40:30",
"item_name": "外部データ設定",
"data": [
{
"id": "C5",
"type": "date",
"value": "2023年01月18日",
"title": "開始日"
},
{
"id": "C10",
"type": "time",
"value": "10時40分",
"title": "終了時間"
}
],
"botName": "業務日報",
"info": {
"userId": 123,
"userName": "鈴木一郎",
"email": "suzuki@spalo.co.jp"
}
}
レスポンス 200
正常系のレスポンスは下記の形式でデータを返してください。
- HTTPステータスコード：200
- Content-Type：application/Json
- 文字コード：UTF-8
responseObject
| 名前 | 型 | 備考 |
|---|---|---|
| type | string | dataset |
| actions | array | 下記参照（最大データ件数：200） |
actions
| 名前 | 型 | 最大文字数 | 備考 |
|---|---|---|---|
| key | string | 50 | 自動設定する回答タイプの項目名 |
| value | string | 50 | 値 |
レスポンス例
{
"type": "dataset",
"actions": [
{
"key": "住所",
"value": "東京都中央区銀座1-2-3-4-5"
},
{
"key": "電話番号",
"value": "03-9999-9999"
}
]
}レスポンス 400
異常系のレスポンスは、標準的なエラーのほか、独自のエラーメッセージを返すことができます。
メッセージと共に「戻って・スキップ」ボタンをチャットツールに表示します。
- HTTPステータスコード：400
- Content-Type：application/Json
- 文字コード：UTF-8
responseObject
| パラメータ | 型 | 内容 |
|---|---|---|
| type | string | text |
| text | string | 任意の文字列 |
標準エラー
return res.status(400).send();カスタムエラー
return res.status(400).send({
type: "text",
text: "設定できるデータがありません。",
});表示例
