[新しいボットAPIとしてボットをインポート]、または [既存のボットAPIにボットをインポート] を使用して開始されたボットのインポートリクエストのステータスを取得するために使用されます。

このAPIには、ボット管理者コンソールからのみ作成されたアプリケーションによって生成されたJWTが必要です。このAPIを使用するために、アプリは [ボット定義] の [ボットをインポート] の管理APIスコープを必要とします。

GET https://{{host}}/api/public/bot/import/status/{{BotImportBIR}}

クエリパラメータ

認証

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

応答のコンテンツタイプ

application/json

サンプルリクエスト

curl -X GET \ https://{{host}}/api/public/bot/import/status/bir-xxxxxxx-xxx-xxxx-xxxxx-xxxxxxxxxx \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \

サンプル応答

{ "_id": "bir-xxxxxxx-xxx-xxxx-xxxxx-xxxxxxxxxx", "botRefId": "f6e63f2d-cw20-52b0-bbc5-638add8dba26", "statusLogs": [ { "taskType": "importRequest", "taskName": "Sample Bot", "status": "success" }, { "taskType": "Bot Definition", "taskName": "Sample Bot", "status": "success" }, { "taskType": "CustomTemplates", "taskName": "CustomTemplates", "status": "success" }, { "taskType": "BotVariables", "taskName": "BotVariables", "status": "success" }, { "taskType": "Dialog", "taskName": "Task 1", "status": "success" }, { "taskType": "Dialog", "taskName": "Task 2", "status": "success" }, { "taskType": "Utterances", "taskName": "Utterances", "status": "success" }, { "taskType": "importBot", "taskName": "Sample Bot", "status": "success" } ], "createdBy": "u-3ae3ed39-a65b-5b2c-b55b-85864a8202c3", "requestType": "Botimport", "status": "success", "createdOn": "2018-12-05T07:45:14.376Z", "__v": 0, "botId": "st-b4542w96-49ec-5d95-a120-c6244fc23777" }

Used to get the status of the bot import request initiated using Import Bot as New Bot API or Import Bot into an Existing Bot API.

This API requires JWT generated by an application created only from Bot Admin Console.
To use this API, app needs the Admin API Scope of Bot Import under Bot Definition.

GET https://{{host}}/api/public/bot/import/status/{{BotImportBIR}}

Query Parameters

Authorization

Invoke the API with JWT in the header with the following syntax:

auth: {{JWT}}

Response content type

application/json

Sample Request

curl -X GET \
  https://{{host}}/api/public/bot/import/status/bir-xxxxxxx-xxx-xxxx-xxxxx-xxxxxxxxxx \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \

Sample Response

{
    "_id": "bir-xxxxxxx-xxx-xxxx-xxxxx-xxxxxxxxxx",
    "botRefId": "f6e63f2d-cw20-52b0-bbc5-638add8dba26",
    "statusLogs": [
        {
            "taskType": "importRequest",
            "taskName": "Sample Bot",
            "status": "success"
        },
        {
            "taskType": "Bot Definition",
            "taskName": "Sample Bot",
            "status": "success"
        },
        {
            "taskType": "CustomTemplates",
            "taskName": "CustomTemplates",
            "status": "success"
        },
        {
            "taskType": "BotVariables",
            "taskName": "BotVariables",
            "status": "success"
        },
        {
            "taskType": "Dialog",
            "taskName": "Task 1",
            "status": "success"
        },
        {
            "taskType": "Dialog",
            "taskName": "Task 2",
            "status": "success"
        },
        {
            "taskType": "Utterances",
            "taskName": "Utterances",
            "status": "success"
        },
        {
            "taskType": "importBot",
            "taskName": "Sample Bot",
            "status": "success"
        }
    ],
    "createdBy": "u-3ae3ed39-a65b-5b2c-b55b-85864a8202c3",
    "requestType": "Botimport",
    "status": "success",
    "createdOn": "2018-12-05T07:45:14.376Z",
    "__v": 0,
    "botId": "st-b4542w96-49ec-5d95-a120-c6244fc23777"
}