[新しいボットとしてボットをインポート] は、ファイルをローカルサーバーにアップロードすることで生成されたファイルIDを使用し、アカウントオーナーのビルダーツールで新しいボットを作成するために使用されます。ファイルIDのアップロードおよび取得方法については、「ファイルAPIをアップロード」を参照してください。
このAPIには、ボット管理者コンソールからのみ作成されたアプリケーションによって生成されたJWTが必要です。このAPIを使用するために、アプリは [ボット定義] の [ボットをインポート] の管理APIスコープを必要とします。
ポスト https://{{host}}/api/public/bot/import
クエリパラメータ
パラメータ | 説明 |
---|---|
ホスト | 環境URL(例: https://bots.kore.ai) |
本文パラメータ
パラメータ | 説明 |
---|---|
botDefinition | 「ボットの定義ファイルID」 ファイルIDのアップロードおよび取得方法については、「ファイルAPIをアップロード」を参照してください。 |
configInfo | 「ボットの設定ファイルID」 ファイルIDのアップロードおよび取得方法については、「ファイルAPIをアップロード」を参照してください。 |
botFunctions(任意) | 「ボットの機能ファイルID」 ファイルIDのアップロードおよび取得方法については、「ファイルAPIをアップロード」を参照してください。 |
icon | 「ボットのアイコンファイルID」 ファイルIDのアップロードおよび取得方法については、「ファイルAPIをアップロード」を参照してください。 |
name(任意) | 「ボット名」 指定されていない場合は、既存のボットのコピーから取得されます。 |
purpose(任意) | 「カスタマー」/「従業員」 指定されていない場合は、既存のボットのコピーから取得されます。 |
認証
以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。 auth: {{JWT}}
応答のコンテンツタイプ
application/json
サンプルリクエスト
curl -X POST \ https://{{host}}/api/public/bot/import \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ -H 'content-type: application/json' \ -d '{ "botDefinition" : "5b7ed3c87cab5c48ea9794f9", "configInfo" : "5b7ed2w77cab5c48ea9794fa", "botFunctions":["5b7ed13a86a5fc48f4777ea6"], "icon":"5b7ed3837cab5c48ea9794fb" }'
サンプル応答
{ "streamRefId": "f6e21f2d-cf90-52b0-bbc5-638add8dba26", "statusLogs": [ { "taskType": "importRequest", "taskName": "SampleTaskName", "status": "success" } ], "createdBy": "u-3ae8bd39-a65b-5b2c-b66b-85864a8202c3", "requestType": "Botimport", "_id": "bir-32a5ed0d-6181-5a0a-9f21-1bf872290029", "status": "pending", "createdOn": "2018-12-05T07:28:46.113Z", "__v": 0 }