Bot Variables Import API

グローバル変数とコンテンツ変数をボットにインポートします。

このAPIを使用するためには、アプリに変数のインポートのボットビルダーAPIスコープが必要となります。

POST https://{{host}}/api/{{version}}/public/builder/bot/{{BotID}}/variables/import

クエリパラメータ

パラメータ	説明
host	環境URL、例： https://bots.kore.ai
BotID	ボットID。ボットの「一般設定」ページからアクセスできます。

本文パラメータ

パラメータ	説明
key	変数の名前
value	変数の値
hint	変数の説明
variableType	変数のタイプは以下のとおりですグローバル変数を表すenvまたはコンテンツ変数のロケール
scope	変数のスコープは、変数宣言時のセットアップオプションに合わせて、以下のとおりです prePopulated askOnInstall hidden
localeData	ロケールタイプの変数の場合、追加の言語データは言語ごとに以下の形式で渡す必要があります。 { "en": { "value": "english language prompt", "hint": "" } }

認証

ヘッダー内のJWTを含むAPIを、以下の構文で呼び出します。 auth: {{JWT}}

応答コンテンツタイプ

application/JSON

サンプルのリクエスト

curl -X POST \
  https://{{host}}/api/1.1/public/builder/bot/{{BotId}}/variables/import \
  -H 'Content-Type: application/json' \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -d '[
  {
    "key": "Global",
    "value": "Globalkey-prePopulated",
    "hint": "",
    "variableType": "env",
    "scope": "prePopulated"
  },
	{
    "key": "Lang",
    "variableType": "locale",
    "scope": "prePopulated",
    "localeData": {
      "en": {
        "value": "english language prompt",
        "hint": ""
      }
    }
  }
]'

コレクションが有効な場合のサンプルリクエスト

curl -X POST \
  https://{{host}}/api/1.1/public/builder/bot/{{BotId}}/variables/import \
--header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "botVariables": [
        {
            "key": "CVar",
            "value": "Cvar1",
            "hint": "",
            "audioTag": "",
            "variableType": "locale",
            "scope": "prePopulated",
            "localeData": {
                "en": {
                    "value": "Cvar1",
                    "hint": "",
                    "audioTag": ""
                }
            },
            "group": "",
            "propagateValue": false,
            "vNameSpace": [
                {
                    "name": "default",
                    "refId": "10e5fcd0-4f9b-5092-b249-3aebeb01c017"
                }
            ]
        },
        {
            "key": "GKey1",
            "value": "GValue1-C",
            "hint": "GNotes1",
            "audioTag": "",
            "variableType": "env",
            "scope": "prePopulated",
            "group": "",
            "propagateValue": false,
            "vNameSpace": [
                {
                    "name": "default",
                    "refId": "10e5fcd0-4f9b-5092-b249-3aebeb01c017"
                }
            ]
        },
        {
            "key": "GKey2",
            "value": "Gkey2Stag",
            "hint": "GNotes2",
            "audioTag": "",
            "variableType": "env",
            "scope": "prePopulated",
            "group": "",
            "propagateValue": false,
            "vNameSpace": [
                {
                    "name": "default",
                    "refId": "10e5fcd0-4f9b-5092-b249-3aebeb01c017"
                }
            ]
        },
        {
            "key": "GKey55",
            "value": "GKey55-Staging",
            "hint": "GNotes2",
            "audioTag": "",
            "variableType": "env",
            "scope": "prePopulated",
            "propagateValue": false,
            "vNameSpace": [
                {
                    "name": "default",
                    "refId": "10e5fcd0-4f9b-5092-b249-3aebeb01c017"
                }
            ]
        },
        {
            "key": "contentvar",
            "value": "contvarvalue",
            "hint": "This is content variable",
            "audioTag": "",
            "variableType": "locale",
            "scope": "prePopulated",
            "localeData": {
                "en": {
                    "value": "contvarvalue",
                    "hint": "This is content variable",
                    "audioTag": ""
                }
            },
            "group": "",
            "propagateValue": false,
            "vNameSpace": [
                {
                    "name": "default",
                    "refId": "10e5fcd0-4f9b-5092-b249-3aebeb01c017"
                }
            ]
        }
    ],
    "botCollections": [
        {
            "name": "Default",
            "description": "Default Collection",
            "refId": "8e65ff0a-edac-5641-b27d-5614a4e94c0c"
        },
        {
            "name": "Staging",
            "description": "Staging Environment",
            "refId": "0c033a41-3988-52a5-bc1c-02a4a10863b3"
        }
    ],
    "botCollectionVariables": [
        {
            "key": "GKey1",
            "value": "GValue1-C",
            "audioTag": "",
            "refId": "0c033a41-3988-52a5-bc1c-02a4a10863b3"
        },
        {
            "key": "GKey1",
            "value": "GValue1-C",
            "audioTag": "",
            "refId": "8e65ff0a-edac-5641-b27d-5614a4e94c0c"
        },
        {
            "key": "GKey2",
            "value": "Gkey2Stag",
            "audioTag": "",
            "refId": "0c033a41-3988-52a5-bc1c-02a4a10863b3"
        },
        {
            "key": "GKey2",
            "value": "Gkey2Diff",
            "audioTag": "",
            "refId": "8e65ff0a-edac-5641-b27d-5614a4e94c0c"
        },
        {
            "key": "GKey55",
            "value": "GKey55-Staging",
            "audioTag": "",
            "refId": "0c033a41-3988-52a5-bc1c-02a4a10863b3"
        },
        {
            "key": "GKey55",
            "value": "GKey55-Default",
            "audioTag": "testaudioTag",
            "refId": "8e65ff0a-edac-5641-b27d-5614a4e94c0c"
        }
    ]
}'

サンプルのレスポンス

{
  "message": "2 Variables imported/updated successfully."
}

On this Page