봇 정의와 모든 관련 구성 요소를 내보내는 데 사용됩니다. 이 API는 내보내기 프로세스만 시작합니다. 내보내기 상태 API를 사용하여 내보내기 과정을 확인하고 내보내기가 완료된 후 파일을 다운로드할 수 있는 링크를 가져옵니다.
이 API를 사용하려면 앱에는 봇 정의 아래에 있는 봇 내보내기의 관리자 API 범위가 필요합니다.
POST https://{{host}}/api/public/bot/{{BotID}}/export
쿼리 매개 변수
| 매개 변수 | 설명 |
|---|---|
| host | 환경 URL, 예: https://bots.kore.ai |
| BotID | 봇 ID 또는 스트림 ID. 봇의 일반 설정 페이지에서 이를 액세스할 수 있습니다. |
본문 매개 변수
| 매개 변수 | 설명 |
|---|---|
| exportType |
봇 유형 –
|
| exportOptions (선택 사항) |
모든 봇 구성 요소는 기본적으로 내보내집니다. 필요한 경우 내보내기에 포함할 구성 요소를 지정할 수 있습니다. "exportOptions": {
"tasks": [
"botTask",
"knowledgeGraph"
],
"nlpData": [
"nlpSettings",
"utterances",
"standardResponses"
],
"settings": [
"botSettings",
"botVariables",
"ivrSettings"
]
},
|
| subTasks (선택 사항) |
부분 내보내기의 경우 내보낼 작업을 언급합니다. "subTasks": {
"dialogs": ["<dialog Name 1>","<dialog Name 2>"],
"alerts": ["<alert name 1>","<alert name 2>"],
"actions": ["<action name 1>","<action name 2>"]
}
|
| IncludeDependentTasks (선택 사항) |
내보낼 종속 작업을 포함합니다 "IncludeDependentTasks": |
| allTasks(선택 사항) |
내보낼 모든 작업을 포함하려면 subTasks가 있는 경우 무시됩니다. "allTasks": |
부분 가져오기 및 종속 작업의 선택적 매개 변수에 대한 자세한 내용은 여기를 참조하세요.
권한 부여
다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다. auth: {{JWT}}
콘텐츠 유형 응답
application/json
샘플 요청
curl -X POST \
https://{{host}}/api/public/bot/{{BotID}/export \
-H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
-H 'content-type: application/json' \
-d '{
"exportType": "published"
}'
샘플 응답
{
"status": "pending",
"streamId": "st-xxxxx-xxx-xxx-xxx-xxxxx",
"createdBy": "u-xxx-xxx-xxx-xxx-xxxxx",
"exportType": "published",
"requestType": "Botexport",
"_id": "ber-xxxxx-xxx-xxx-xxx-xxxxx",
"status": "pending",
"createdOn": "2018-12-05T07:18:40.028Z",
"__v": 0
}