チャットボット
チャットボットとやり取りします
トリガー
このノードでフローを開始できるイベントです。トリガーを選択 から追加します。
メッセージ送信
チャットボットからユーザーに応答が送信されたときにトリガーされます
設定項目
設定項目はありません。
出力
後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば channelId は $trigger.output.channelId です。
{
"channelId": "string",
"traits": {
"organizationId": "string",
"botId": "string",
"integrationId": "string"
},
"content": {
"userId": "string",
"messages": [
{}
],
"replyToken": "string",
"channels": [
"string"
],
"data": {
"messages": [
{}
]
}
}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
channelId | テキスト | チャンネルのID |
traits | オブジェクト | イベントの特性 |
traits.organizationId | テキスト | 組織のID |
traits.botId | テキスト | ボットのID |
traits.integrationId | テキスト | 統合のID |
content | オブジェクト | 送信したメッセージの内容 |
content.userId | テキスト | ユーザーのID（LINEに送信されるメッセージで使用） |
content.messages[] | リスト | イベントのメッセージ（LINEに送信されるメッセージで使用） |
content.replyToken | テキスト | イベントの返信トークン（LINEに送信されるメッセージで使用） |
content.channels[] | リスト | Websocketチャンネル（WEBに送信されるメッセージで使用） |
content.data | オブジェクト | 送信されたメッセージのデータ（WEBに送信されるメッセージで使用） |
content.data.messages[] | リスト | イベントのメッセージ（WEBに送信されるメッセージで使用） |
content.data.messages[].type | テキスト | メッセージのタイプ |
content.data.messages[].from | テキスト | メッセージの送信元 |
content.data.messages[].data | オブジェクト | メッセージのデータ（メッセージのタイプによって構造が異なります） |
メッセージ受信
ユーザーからチャットボットに新しいメッセージが受信されたときにトリガーされます
設定項目
設定項目はありません。
出力
後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば botId は $trigger.output.botId です。
{
"botId": "string",
"integrationId": "string",
"organizationId": "string",
"userId": "string",
"platform": {},
"data": {
"events": [
{
"type": "string",
"source": {},
"message": {},
"variables": "string"
}
]
}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
botId | テキスト | ボットのID |
integrationId | テキスト | 統合のID |
organizationId | テキスト | 組織のID |
userId | テキスト | ユーザーのID |
platform | オブジェクト | プラットフォーム会話（line、web） |
data | オブジェクト | 受信したメッセージのデータ |
data.events[] | リスト | 会話のイベント |
data.events[].type | テキスト | イベントのタイプ |
data.events[].source | オブジェクト | イベントのソース |
data.events[].source.type | テキスト | ソースのタイプ |
data.events[].source.userId | テキスト | ユーザーのID |
data.events[].message | オブジェクト | メッセージデータ |
data.events[].message.type | テキスト | メッセージのタイプ |
data.events[].message.data | オブジェクト | メッセージのデータ |
data.events[].variables | キーと値のペア | 変数 |
アクション
このノードが実行できる処理です。ステップを追加 からノードを追加し、アクションを選びます。
ボット作成
新しいチャットボットを作成します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 名前 | テキスト | はい | ボットの名前 |
| 説明 | テキスト | ボットの説明 | |
| ボット接続 | はい / いいえ | ボットを接続するかどうかを選択します |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"name": "string",
"avatar": "string",
"organizationId": "string",
"status": "string",
"description": "string",
"diagramVersion": 0,
"isConnected": false,
"metadata": "string",
"settings": {
"intentGlobalNoMatch": "string",
"timeoutFlowEnabled": false,
"endConversationMessage": {
"enable": false,
"message": "string"
}
},
"created": "string",
"updated": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | ボットの一意の識別子 |
name | テキスト | ボットの名前 |
avatar | テキスト | ボットのアバターURL |
organizationId | テキスト | ボットを所有する組織のID |
status | テキスト | ボットの現在のステータス（DRAFT、PUBLISHED、UNPUBLISHED） |
description | テキスト | ボットの説明 |
diagramVersion | 数値 | ボットのダイアグラムのバージョン番号 |
isConnected | はい / いいえ | ボットが現在接続されているかどうか |
metadata | キーと値のペア | ボットの追加メタデータ |
settings | オブジェクト | ボットの設定 |
settings.intentGlobalNoMatch | テキスト | グローバルマッチなしインテント設定 |
settings.timeoutFlowEnabled | はい / いいえ | タイムアウトフローが有効かどうか |
settings.endConversationMessage | オブジェクト | 会話終了メッセージの設定 |
settings.endConversationMessage.enable | はい / いいえ | 会話終了メッセージを有効にするかどうか |
settings.endConversationMessage.message | テキスト | 会話終了メッセージのテキスト |
created | テキスト | ボットが作成されたタイムスタンプ |
updated | テキスト | ボットが最後に更新されたタイムスタンプ |
ボット一覧取得
すべてのチャットボットを取得します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 制限 | 数値 | はい | 取得するボットの数を制限します 既定値: 20 |
| 次へ | テキスト | 次のページのボットを取得するための次のカーソル |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば data[0].id は $.<ステップID>.output.data[0].id です。
{
"data": [
{
"id": "string",
"name": "string",
"avatar": "string",
"organizationId": "string",
"status": "string",
"description": "string",
"diagramVersion": 0,
"isConnected": false,
"metadata": "string",
"settings": {
"intentGlobalNoMatch": "string",
"timeoutFlowEnabled": false,
"endConversationMessage": {}
},
"created": "string",
"updated": "string"
}
],
"pagination": {
"limit": 0,
"next": "string"
}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
data[] | リスト | アイテムのデータ |
data[].id | テキスト | ボットの一意の識別子 |
data[].name | テキスト | ボットの名前 |
data[].avatar | テキスト | ボットのアバターURL |
data[].organizationId | テキスト | ボットを所有する組織のID |
data[].status | テキスト | ボットの現在のステータス（DRAFT、PUBLISHED、UNPUBLISHED） |
data[].description | テキスト | ボットの説明 |
data[].diagramVersion | 数値 | ボットのダイアグラムのバージョン番号 |
data[].isConnected | はい / いいえ | ボットが現在接続されているかどうか |
data[].metadata | キーと値のペア | ボットの追加メタデータ |
data[].settings | オブジェクト | ボットの設定 |
data[].settings.intentGlobalNoMatch | テキスト | グローバルマッチなしインテント設定 |
data[].settings.timeoutFlowEnabled | はい / いいえ | タイムアウトフローが有効かどうか |
data[].settings.endConversationMessage | オブジェクト | 会話終了メッセージの設定 |
data[].settings.endConversationMessage.enable | はい / いいえ | 会話終了メッセージを有効にするかどうか |
data[].settings.endConversationMessage.message | テキスト | 会話終了メッセージのテキスト |
data[].created | テキスト | ボットが作成されたタイムスタンプ |
data[].updated | テキスト | ボットが最後に更新されたタイムスタンプ |
pagination | オブジェクト | ページネーション情報 |
pagination.limit | 数値 | 1ページあたりに取得するアイテム数 |
pagination.next | テキスト | 次のページのアイテムを取得するための次のカーソル |
ボット更新
既存のチャットボットを更新します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | 更新するボットのID |
| 名前 | テキスト | ボットの名前 | |
| 説明 | テキスト | ボットの説明 | |
| ステータス | 選択 | 選択肢: 下書き, 公開済み, 非公開 | |
| ボット接続 | はい / いいえ | ボットを接続するかどうか |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"name": "string",
"avatar": "string",
"organizationId": "string",
"status": "string",
"description": "string",
"diagramVersion": 0,
"isConnected": false,
"metadata": "string",
"settings": {
"intentGlobalNoMatch": "string",
"timeoutFlowEnabled": false,
"endConversationMessage": {
"enable": false,
"message": "string"
}
},
"created": "string",
"updated": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | ボットの一意の識別子 |
name | テキスト | ボットの名前 |
avatar | テキスト | ボットのアバターURL |
organizationId | テキスト | ボットを所有する組織のID |
status | テキスト | ボットの現在のステータス（DRAFT、PUBLISHED、UNPUBLISHED） |
description | テキスト | ボットの説明 |
diagramVersion | 数値 | ボットのダイアグラムのバージョン番号 |
isConnected | はい / いいえ | ボットが現在接続されているかどうか |
metadata | キーと値のペア | ボットの追加メタデータ |
settings | オブジェクト | ボットの設定 |
settings.intentGlobalNoMatch | テキスト | グローバルマッチなしインテント設定 |
settings.timeoutFlowEnabled | はい / いいえ | タイムアウトフローが有効かどうか |
settings.endConversationMessage | オブジェクト | 会話終了メッセージの設定 |
settings.endConversationMessage.enable | はい / いいえ | 会話終了メッセージを有効にするかどうか |
settings.endConversationMessage.message | テキスト | 会話終了メッセージのテキスト |
created | テキスト | ボットが作成されたタイムスタンプ |
updated | テキスト | ボットが最後に更新されたタイムスタンプ |
ボット取得
既存のチャットボットを取得します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | 取得するボットのID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"name": "string",
"avatar": "string",
"organizationId": "string",
"status": "string",
"description": "string",
"diagramVersion": 0,
"isConnected": false,
"metadata": "string",
"settings": {
"intentGlobalNoMatch": "string",
"timeoutFlowEnabled": false,
"endConversationMessage": {
"enable": false,
"message": "string"
}
},
"created": "string",
"updated": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | ボットの一意の識別子 |
name | テキスト | ボットの名前 |
avatar | テキスト | ボットのアバターURL |
organizationId | テキスト | ボットを所有する組織のID |
status | テキスト | ボットの現在のステータス（DRAFT、PUBLISHED、UNPUBLISHED） |
description | テキスト | ボットの説明 |
diagramVersion | 数値 | ボットのダイアグラムのバージョン番号 |
isConnected | はい / いいえ | ボットが現在接続されているかどうか |
metadata | キーと値のペア | ボットの追加メタデータ |
settings | オブジェクト | ボットの設定 |
settings.intentGlobalNoMatch | テキスト | グローバルマッチなしインテント設定 |
settings.timeoutFlowEnabled | はい / いいえ | タイムアウトフローが有効かどうか |
settings.endConversationMessage | オブジェクト | 会話終了メッセージの設定 |
settings.endConversationMessage.enable | はい / いいえ | 会話終了メッセージを有効にするかどうか |
settings.endConversationMessage.message | テキスト | 会話終了メッセージのテキスト |
created | テキスト | ボットが作成されたタイムスタンプ |
updated | テキスト | ボットが最後に更新されたタイムスタンプ |
ボット削除
既存のチャットボットを削除します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | 削除するボットのID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば data は $.<ステップID>.output.data です。
{
"data": "string",
"status": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
data | 任意 | DECA Chatbot APIが返した結果。形はアクションによって異なります。削除では削除されたレコード、true、空のオブジェクトが返るか、何も返りません |
status | テキスト | DECA Chatbot APIがリクエストを受け付けた場合は "success" |
ダイアグラム取得
チャットボットのダイアグラムを取得します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | ダイアグラムを取得するボットのID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば flows[0].id は $.<ステップID>.output.flows[0].id です。
{
"flows": [
{
"id": "string",
"botId": "string",
"name": "string",
"category": "string",
"type": "string",
"nodes": {},
"configs": {
"intentNodes": []
},
"created": "string",
"updated": "string"
}
],
"version": 0,
"variables": [
{
"botId": "string",
"id": "string",
"name": "string",
"created": "string",
"updated": "string"
}
],
"intents": [
{
"id": "string",
"label": "string",
"language": "string",
"botId": "string",
"utterances": [
"string"
],
"created": "string",
"updated": "string"
}
],
"settings": {}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
flows[] | リスト | ダイアグラム内のフロー |
flows[].id | テキスト | フローのID |
flows[].botId | テキスト | このフローが属するボットのID |
flows[].name | テキスト | フローの名前 |
flows[].category | テキスト | フローのカテゴリ |
flows[].type | テキスト | フローのタイプ |
flows[].nodes | オブジェクト | フロー内のノード |
flows[].configs | オブジェクト | フローの設定 |
flows[].configs.intentNodes[] | リスト | インテントノードの設定 |
flows[].configs.intentNodes[].intentScope | テキスト | インテントのスコープ |
flows[].configs.intentNodes[].intentId | テキスト | インテントのID |
flows[].configs.intentNodes[].ID | テキスト | フローのID |
flows[].created | テキスト | フローが作成されたタイムスタンプ |
flows[].updated | テキスト | フローが最後に更新されたタイムスタンプ |
version | 数値 | ダイアグラムのバージョン番号 |
variables[] | リスト | ダイアグラム内の変数 |
variables[].botId | テキスト | この変数が属するボットのID |
variables[].id | テキスト | 変数のID |
variables[].name | テキスト | 変数の名前 |
variables[].created | テキスト | 変数が作成されたタイムスタンプ |
variables[].updated | テキスト | 変数が最後に更新されたタイムスタンプ |
intents[] | リスト | ダイアグラム内のインテント |
intents[].id | テキスト | インテントのID |
intents[].label | テキスト | インテントのラベル |
intents[].language | テキスト | インテントの言語 |
intents[].botId | テキスト | このインテントが属するボットのID |
intents[].utterances[] | リスト | インテントの発話リスト |
intents[].created | テキスト | インテントが作成されたタイムスタンプ |
intents[].updated | テキスト | インテントが最後に更新されたタイムスタンプ |
settings | オブジェクト | ダイアグラムの設定 |
ダイアグラムバージョン一覧取得
チャットボットのダイアグラムのすべてのバージョンを取得します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | |
| タイプ | 選択 | 選択肢: ユーザー作成, 自動生成 | |
| 制限 | 数値 | はい | 取得する最大バージョン数を選択または入力します。 既定値: 20 |
| 次のカーソル | テキスト | ダイアグラムバージョンを取得するボットのID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば data[0].name は $.<ステップID>.output.data[0].name です。
{
"data": [
{
"name": "string",
"botId": "string",
"created": "string",
"updated": "string",
"version": 0,
"type": "string"
}
],
"pagination": {
"limit": 0,
"next": "string"
}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
data[] | リスト | アイテムのデータ |
data[].name | テキスト | ダイアグラムバージョンの名前 |
data[].botId | テキスト | このダイアグラムバージョンが属するボットのID |
data[].created | テキスト | ダイアグラムバージョンが作成されたタイムスタンプ |
data[].updated | テキスト | ダイアグラムバージョンが最後に更新されたタイムスタンプ |
data[].version | 数値 | ダイアグラムのバージョン番号 |
data[].type | テキスト | ダイアグラムバージョンのタイプ |
pagination | オブジェクト | ページネーション情報 |
pagination.limit | 数値 | 1ページあたりに取得するアイテム数 |
pagination.next | テキスト | 次のページのアイテムを取得するための次のカーソル |
ダイアグラムバージョン作成
ダイアグラムの新しいバージョンを作成します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | ダイアグラムバージョンを作成するボットのID |
| 名前 | テキスト | ダイアグラムバージョンの名前 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば data は $.<ステップID>.output.data です。
{
"data": "string",
"status": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
data | 任意 | |
data.name | テキスト | ダイアグラムバージョンの名前 |
data.botId | テキスト | このダイアグラムバージョンが属するボットのID |
data.created | テキスト | ダイアグラムバージョンが作成されたタイムスタンプ |
data.updated | テキスト | ダイアグラムバージョンが最後に更新されたタイムスタンプ |
data.version | 数値 | ダイアグラムのバージョン番号 |
data.type | テキスト | ダイアグラムバージョンのタイプ |
status | テキスト | DECA Chatbot APIがリクエストを受け付けた場合は "success" |
ダイアグラムバージョン取得
ダイアグラムのバージョンを取得します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | ダイアグラムバージョンを取得するボットのID |
| バージョン | 数値 | はい | 取得するダイアグラムのバージョン番号 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば name は $.<ステップID>.output.name です。
{
"name": "string",
"botId": "string",
"created": "string",
"updated": "string",
"version": 0,
"type": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
name | テキスト | ダイアグラムバージョンの名前 |
botId | テキスト | このダイアグラムバージョンが属するボットのID |
created | テキスト | ダイアグラムバージョンが作成されたタイムスタンプ |
updated | テキスト | ダイアグラムバージョンが最後に更新されたタイムスタンプ |
version | 数値 | ダイアグラムのバージョン番号 |
type | テキスト | ダイアグラムバージョンのタイプ |
ダイアグラムバージョン削除
ダイアグラムのバージョンを削除します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | ダイアグラムバージョンを削除するボットのID |
| バージョン | 数値 | はい | 削除するダイアグラムのバージョン番号 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば data は $.<ステップID>.output.data です。
{
"data": "string",
"status": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
data | 任意 | DECA Chatbot APIが返した結果。形はアクションによって異なります。削除では削除されたレコード、true、空のオブジェクトが返るか、何も返りません |
status | テキスト | DECA Chatbot APIがリクエストを受け付けた場合は "success" |
ダイアグラムバージョン復元
ダイアグラムのバージョンを復元します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | ダイアグラムバージョンを復元するボットのID |
| バージョン | 数値 | はい | 復元するダイアグラムのバージョン番号 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば data.success は $.<ステップID>.output.data.success です。
{
"data": {
"success": false
},
"status": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
data | オブジェクト | DECA Chatbot APIが報告した結果 |
data.success | はい / いいえ | 操作が成功したかどうか |
status | テキスト | DECA Chatbot APIがリクエストを受け付けた場合は "success" |
統合一覧取得
すべての統合を取得します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | 統合を取得するボットのID |
| 制限 | 数値 | はい | 取得する統合の数を制限します 既定値: 20 |
| 次へ | テキスト | 次のページの統合を取得するための次のカーソル | |
| 前へ | テキスト | 前のページの統合を取得するための前のカーソル |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば data[0].organizationId は $.<ステップID>.output.data[0].organizationId です。
{
"data": [
{
"organizationId": "string",
"integrationType": "line",
"name": "string",
"ocsChannelId": "string",
"externalId": "string",
"metadata": "string",
"created": "string",
"updated": "string",
"configs": {},
"integrationId": "string",
"platform": "CHATBOX",
"status": "ENABLE",
"botId": "string"
}
],
"pagination": {
"limit": 0,
"next": "string"
}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
data[] | リスト | アイテムのデータ |
data[].organizationId | テキスト | 統合を所有する組織のID |
data[].integrationType | テキスト | 統合のタイプ |
data[].name | テキスト | 統合の名前 |
data[].ocsChannelId | テキスト | 統合のOCSチャンネルID |
data[].externalId | テキスト | 統合の外部ID |
data[].metadata | キーと値のペア | 統合の追加メタデータ |
data[].created | テキスト | 統合が作成されたタイムスタンプ |
data[].updated | テキスト | 統合が最後に更新されたタイムスタンプ |
data[].configs | オブジェクト | 統合の設定 |
data[].integrationId | テキスト | 統合のID |
data[].platform | テキスト | 統合のプラットフォーム、値は'CHATBOX'、'WEB'、'LINE' |
data[].status | テキスト | 統合のステータス、値は'ENABLE'、'DISABLE'、'PENDING' |
data[].botId | テキスト | 統合を所有するボットのID |
pagination | オブジェクト | ページネーション情報 |
pagination.limit | 数値 | 1ページあたりに取得するアイテム数 |
pagination.next | テキスト | 次のページのアイテムを取得するための次のカーソル |
サードパーティ統合削除
サードパーティ統合を削除します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | 統合を削除するボットのID |
| 統合ID | テキスト | はい | 削除する統合のID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば data は $.<ステップID>.output.data です。
{
"data": "string",
"status": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
data | 任意 | DECA Chatbot APIが返した結果。形はアクションによって異なります。削除では削除されたレコード、true、空のオブジェクトが返るか、何も返りません |
status | テキスト | DECA Chatbot APIがリクエストを受け付けた場合は "success" |
統合取得
統合を取得します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | 統合を取得するボットのID |
| 統合ID | テキスト | はい | 取得する統合のID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば organizationId は $.<ステップID>.output.organizationId です。
{
"organizationId": "string",
"integrationType": "line",
"name": "string",
"ocsChannelId": "string",
"externalId": "string",
"metadata": "string",
"created": "string",
"updated": "string",
"configs": {},
"integrationId": "string",
"platform": "CHATBOX",
"status": "ENABLE",
"botId": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
organizationId | テキスト | 統合を所有する組織のID |
integrationType | テキスト | 統合のタイプ |
name | テキスト | 統合の名前 |
ocsChannelId | テキスト | 統合のOCSチャンネルID |
externalId | テキスト | 統合の外部ID |
metadata | キーと値のペア | 統合の追加メタデータ |
created | テキスト | 統合が作成されたタイムスタンプ |
updated | テキスト | 統合が最後に更新されたタイムスタンプ |
configs | オブジェクト | 統合の設定 |
integrationId | テキスト | 統合のID |
platform | テキスト | 統合のプラットフォーム、値は'CHATBOX'、'WEB'、'LINE' |
status | テキスト | 統合のステータス、値は'ENABLE'、'DISABLE'、'PENDING' |
botId | テキスト | 統合を所有するボットのID |
統合無効化
統合を無効にします
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | 統合を無効にするボットのID |
| 統合ID | テキスト | はい | 無効にする統合のID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば data.success は $.<ステップID>.output.data.success です。
{
"data": {
"success": false
},
"status": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
data | オブジェクト | DECA Chatbot APIが報告した結果 |
data.success | はい / いいえ | 操作が成功したかどうか |
status | テキスト | DECA Chatbot APIがリクエストを受け付けた場合は "success" |
フロー更新
フローを更新します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | フローを更新するボットのID |
| フローID | テキスト | はい | 更新するフローのID |
| 名前 | テキスト | フローの名前 | |
| 説明 | テキスト | フローの説明 | |
| カテゴリ | 選択 | フローのカテゴリ 選択肢: トピック, コンポーネント, スニペット |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"botId": "string",
"name": "string",
"category": "topic",
"type": "start",
"description": "string",
"creator": "string",
"nodes": {},
"configs": {
"intentNodes": [
{
"intentScope": "string",
"intentId": "string",
"ID": "string"
}
]
}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | フローのID |
botId | テキスト | フローを所有するボットのID |
name | テキスト | フローの名前 |
category | テキスト | フローのカテゴリ |
type | テキスト | フローのタイプ（'start'、'timeout'、'error'、'end'、'normal'） |
description | テキスト | フローの説明 |
creator | テキスト | フローの作成者 |
nodes | オブジェクト | フローのノード |
configs | オブジェクト | フローの設定 |
configs.intentNodes[] | リスト | インテントノードの設定 |
configs.intentNodes[].intentScope | テキスト | インテントのスコープ |
configs.intentNodes[].intentId | テキスト | インテントのID |
configs.intentNodes[].ID | テキスト | フローのID |
フロー削除
フローを削除します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | フローを削除するボットのID |
| フローID | テキスト | はい | 削除するフローのID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば data は $.<ステップID>.output.data です。
{
"data": "string",
"status": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
data | 任意 | DECA Chatbot APIが返した結果。形はアクションによって異なります。削除では削除されたレコード、true、空のオブジェクトが返るか、何も返りません |
status | テキスト | DECA Chatbot APIがリクエストを受け付けた場合は "success" |
フロー複製
フローを複製します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | フローを複製するボットのID |
| フローID | テキスト | はい | 複製するフローのID |
| 名前 | テキスト | フローの名前 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば data は $.<ステップID>.output.data です。
{
"data": "string",
"status": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
data | 任意 | |
data.id | テキスト | フローのID |
data.botId | テキスト | フローを所有するボットのID |
data.name | テキスト | フローの名前 |
data.category | テキスト | フローのカテゴリ |
data.type | テキスト | フローのタイプ（'start'、'timeout'、'error'、'end'、'normal'） |
data.description | テキスト | フローの説明 |
data.creator | テキスト | フローの作成者 |
data.nodes | オブジェクト | フローのノード |
data.configs | オブジェクト | フローの設定 |
data.configs.intentNodes[] | リスト | インテントノードの設定 |
data.configs.intentNodes[].intentScope | テキスト | インテントのスコープ |
data.configs.intentNodes[].intentId | テキスト | インテントのID |
data.configs.intentNodes[].ID | テキスト | フローのID |
status | テキスト | DECA Chatbot APIがリクエストを受け付けた場合は "success" |
インテント作成
インテントを作成します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | インテントを作成するボットのID |
| ラベル | テキスト | はい | インテントのラベル |
| 言語 | 選択 | はい | インテントの言語 選択肢: 英語, 日本語 |
| 発話 | リスト | はい | インテントの発話リスト |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"label": "string",
"language": "en",
"botId": "string",
"utterances": [
"string"
]
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | インテントのID |
label | テキスト | インテントのラベル |
language | テキスト | インテントの言語 |
botId | テキスト | インテントを所有するボットのID |
utterances[] | リスト | インテントの発話リスト |
インテント一覧取得
ページネーションでインテントをすべて取得します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | インテントを取得するボットのID |
| 制限 | 数値 | はい | 取得するインテントの数を制限します 既定値: 20 |
| 次へ | テキスト | 次のページのインテントを取得するための次のカーソル | |
| 前へ | テキスト | 前のページのインテントを取得するための前のカーソル |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば data[0].id は $.<ステップID>.output.data[0].id です。
{
"data": [
{
"id": "string",
"label": "string",
"language": "en",
"botId": "string",
"utterances": [
"string"
]
}
],
"pagination": {
"limit": 0,
"next": "string"
}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
data[] | リスト | アイテムのデータ |
data[].id | テキスト | インテントのID |
data[].label | テキスト | インテントのラベル |
data[].language | テキスト | インテントの言語 |
data[].botId | テキスト | インテントを所有するボットのID |
data[].utterances[] | リスト | インテントの発話リスト |
pagination | オブジェクト | ページネーション情報 |
pagination.limit | 数値 | 1ページあたりに取得するアイテム数 |
pagination.next | テキスト | 次のページのアイテムを取得するための次のカーソル |
インテント取得
インテントを取得します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | インテントを取得するボットのID |
| インテントID | テキスト | はい | 取得するインテントのID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"label": "string",
"language": "en",
"botId": "string",
"utterances": [
"string"
]
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | インテントのID |
label | テキスト | インテントのラベル |
language | テキスト | インテントの言語 |
botId | テキスト | インテントを所有するボットのID |
utterances[] | リスト | インテントの発話リスト |
インテント更新
インテントを更新します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | インテントを更新するボットのID |
| インテントID | テキスト | はい | 更新するインテントのID |
| ラベル | テキスト | インテントのラベル | |
| 言語 | 選択 | インテントの言語 選択肢: 英語, 日本語 | |
| 発話 | リスト | インテントの発話リスト |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"label": "string",
"language": "en",
"botId": "string",
"utterances": [
"string"
]
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | インテントのID |
label | テキスト | インテントのラベル |
language | テキスト | インテントの言語 |
botId | テキスト | インテントを所有するボットのID |
utterances[] | リスト | インテントの発話リスト |
インテント削除
インテントを削除します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | インテントを削除するボットのID |
| インテントID | テキスト | はい | 削除するインテントのID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば data は $.<ステップID>.output.data です。
{
"data": "string",
"status": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
data | 任意 | DECA Chatbot APIが返した結果。形はアクションによって異なります。削除では削除されたレコード、true、空のオブジェクトが返るか、何も返りません |
status | テキスト | DECA Chatbot APIがリクエストを受け付けた場合は "success" |
変数作成
変数を作成します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | 変数を作成するボットのID |
| 名前 | テキスト | はい | 変数の名前 |
| デフォルト値 | テキスト | 変数のデフォルト値 | |
| 説明 | テキスト | 変数の説明 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"botId": "string",
"name": "string",
"defaultValue": "string",
"description": "string",
"created": "string",
"updated": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | 変数のID |
botId | テキスト | 変数を所有するボットのID |
name | テキスト | 変数の名前 |
defaultValue | テキスト | 変数のデフォルト値 |
description | テキスト | 変数の説明 |
created | テキスト | 変数が作成されたタイムスタンプ |
updated | テキスト | 変数が最後に更新されたタイムスタンプ |
変数一覧取得
ページネーションで変数をすべて取得します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | 変数を取得するボットのID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば [0].id は $.<ステップID>.output.[0].id です。
[
{
"id": "string",
"botId": "string",
"name": "string",
"defaultValue": "string",
"description": "string",
"created": "string",
"updated": "string"
}
]例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | 変数のID |
botId | テキスト | 変数を所有するボットのID |
name | テキスト | 変数の名前 |
defaultValue | テキスト | 変数のデフォルト値 |
description | テキスト | 変数の説明 |
created | テキスト | 変数が作成されたタイムスタンプ |
updated | テキスト | 変数が最後に更新されたタイムスタンプ |
変数更新
変数を更新します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | 変数を更新するボットのID |
| 変数ID | テキスト | はい | 更新する変数のID |
| 名前 | テキスト | 変数の名前 | |
| デフォルト値 | テキスト | 変数のデフォルト値 | |
| 説明 | テキスト | 変数の説明 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"botId": "string",
"name": "string",
"defaultValue": "string",
"description": "string",
"created": "string",
"updated": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | 変数のID |
botId | テキスト | 変数を所有するボットのID |
name | テキスト | 変数の名前 |
defaultValue | テキスト | 変数のデフォルト値 |
description | テキスト | 変数の説明 |
created | テキスト | 変数が作成されたタイムスタンプ |
updated | テキスト | 変数が最後に更新されたタイムスタンプ |
変数削除
変数を削除します
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ボットID | テキスト | はい | 変数を削除するボットのID |
| 変数ID | テキスト | はい | 削除する変数のID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば data は $.<ステップID>.output.data です。
{
"data": "string",
"status": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
data | 任意 | DECA Chatbot APIが返した結果。形はアクションによって異なります。削除では削除されたレコード、true、空のオブジェクトが返るか、何も返りません |
status | テキスト | DECA Chatbot APIがリクエストを受け付けた場合は "success" |