ボットのエクスポートリクエストのステータスを取得し、エクスポートが完了した後に、ボットのエクスポートコピーのダウンロードリンクを提供します。ボットのエクスポートAPIの開始についてはこちらを参照してください。

このAPIを使用するために、アプリは [ボット定義] の [ボットのエクスポート] の管理APIスコープを必要とします。

GEThttps://{{host}}/api/public/bot/{{BotID}}/export/status

クエリパラメータ

認証

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

応答のコンテンツタイプ

application/json

サンプルリクエスト

curl -X GET \ https://{{host}}/api/public/bot/{{BotID}}/export/status \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \

サンプル応答

{ "_id": "ber-xxxxx-xxx-xxx-xxx-xxxxx", "botId": "st-xxxxx-xxx-xxx-xxx-xxxxx", "createdBy": "u-xxxxx-xxx-xxx-xxx-xxxxx", "exportType": "published", "requestType": "Botexport", "status": "success", "createdOn": "2018-12-05T07:18:40.028Z", "__v": 0, "downloadURL": "{{url}}", "fileId": "{{file-id}",   "store": { "urlParams": "url-params" }, "fileSize": "947" }

Gets the status of Bot Export request and also provides the download link of the bot export copy after the export is completed. Refer here for initiating Bot Export API.

To use this API, app needs the Admin API Scope of Bot Export under Bot Definition.

GEThttps://{{host}}/api/public/bot/{{BotID}}/export/status

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/{{BotID}}/export/status \
  -H 'auth:  {{YOUR_JWT_ACCESS_TOKEN}}' \

Sample Response

{
    "_id": "ber-xxxxx-xxx-xxx-xxx-xxxxx",
    "botId": "st-xxxxx-xxx-xxx-xxx-xxxxx",
    "createdBy": "u-xxxxx-xxx-xxx-xxx-xxxxx",
    "exportType": "published",
    "requestType": "Botexport",
    "status": "success",
    "createdOn": "2018-12-05T07:18:40.028Z",
    "__v": 0,
    "downloadURL": "{{url}}",
    "fileId": "{{file-id}",
    "store": {
        "urlParams": "url-params"
    },
    "fileSize": "947"
}