봇 내보내기 요청의 상태를 가져오고 내보내기가 완료된 후 봇 내보내기 복사본의 다운로드 링크를 제공합니다. 봇 내보내기 API를 시작하려면 여기를 참조하세요.

이 API를 사용하려면 앱에는 봇 정의 아래에 있는 봇 내보내기의 관리자 API 범위가 필요합니다.

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

쿼리 매개 변수

매개 변수	설명
host	환경 URL(예:https://bots.kore.ai
BotID	봇 ID 또는 스트림 ID. 봇의 일반 설정 페이지에서 이를 액세스할 수 있습니다.

권한 부여

다음 구문을 포함한 헤더에 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"
}

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

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

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

クエリパラメータ

パラメータ	説明
ホスト	環境URL（例：https://bots.kore.ai
BotID）	ボットIDまたはストリームID。ボットの [一般設定] ページからアクセスすることができます。

認証

以下の構文を使用して、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

Parameter	Description
host	Environment URL, for example,https://bots.kore.ai
BotID	Bot ID or Stream ID. You can access it from the General Settings page of the bot.

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"
}