グローバル変数やコンテンツ変数をボットにインポートします。
このAPIを使用するために、アプリは [変数をインポート] のボットビルダーのAPIスコープを必要とします。
ポスト https://{{host}}/api/{{version}}/public/builder/bot/{{BotID}}/variables/import
クエリパラメータ
| パラメータ | 説明 |
|---|---|
| ホスト | 環境URL（例： https://bots.kore.ai） |
| ボットID | ボットID。ボットの [一般設定] ページからアクセスすることができます。 |
本文パラメータ
| パラメータ | 説明 |
|---|---|
| key | 変数の名前 |
| value | 変数の値 |
| hint | 変数の説明 |
| variableType | 変数のタイプは以下の通りです。
|
| scope | 変数の範囲は、変数宣言時の設定オプションに対応しており、以下のいずれかになる可能性があります。
|
| localeData | localeタイプの変数の場合、追加の言語データを言語ごとに以下の形式で渡す必要があります。
{ "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": "" } } } ]'
Sample Request when Collections are enabled
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."}