進行中のボットの公開ステータス、または最後に完了したボットのステータスリクエストを取得します。 ボットAPIの公開の開始については、こちらをご参照ください。
このAPIを使用するには、アプリはボット公開の下にある 公開ステータスの管理者APIスコープを必要とします。
GEThttps://{{host}}/api/public/bot/{{BotID}}/publish/status
認証
ヘッダー内のJWTを含むAPIを、以下の構文で呼び出します。
auth: {{JWT}}
クエリパラメータ
| パラメータ | 説明 |
|---|---|
| host | 環境URL、例：https://bots.kore.ai |
| BotID | ボットIDまたはストリームID。ボットの「一般設定」ページからアクセスできます。 |
応答コンテンツタイプ
application/json
サンプルのリクエスト
curl -X GET \
https://{{host}}/api/1.1/public/bot/{{BotID}}/publish/status/ \
-H 'Auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
サンプルのレスポンス
{
"_id": "ber-xxxxx-xxx-xxx-xxx-xxxxx",
"jobType": "PUBLISH_BOT",
"streamId": "st-xxxxx-xxx-xxx-xxx-xxxxx",
"__v": 0,
"action": "RUN",
"createdBy": "u-xxxxx-xxx-xxx-xxx-xxxxx",
"percentageComplete": 100,
"requestedTime": "2021-12-01T09:19:04.483Z",
"status": "successful",
"lastModifiedOn": "2021-12-01T09:19:05.808Z",
"initiatedOn": "2021-12-01T09:19:04.550Z",
"statusSummary": [
{
"resourceId": "SETTINGS",
"resourceType": "SETTINGS",
"name": "Settings",
"modules": [
"general",
"bot_variables",
"pii",
"ivr",
"hold_resume",
"custom_script",
"advanced"
],
"status": "SUCCESS"
},
{
"resourceId": "NL",
"resourceType": "NL",
"name": "Natural Language",
"modules": [
"nl_model",
"settings"
],
"status": "SUCCESS"
}
]
}
メモ：’status’フィールドの値は、「SUCCESSFUL」「FAILED」または「INPROGRESS」が可能です。
진행 중인 봇의 게시 상태 또는 마지막으로 완료된 봇 상태 요청을 가져옵니다. 봇 게시 API를 시작하려면 여기를 참조하세요.
이 API를 사용하려면 앱은 봇 게시 아래에 있는 게시 상태의 관리자 API 범위가 필요합니다.
GEThttps://{{host}}/api/public/bot/{{BotID}}/publish/status
권한 부여
다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다. auth: {{JWT}}
쿼리 매개 변수
| 매개 변수 | 설명 |
|---|---|
| host | 환경 URL(예:https://bots.kore.ai |
| BotID | 봇 ID 또는 스트림 ID. 봇의 일반 설정 페이지에서 이를 액세스할 수 있습니다. |
콘텐츠 유형 응답
application/json
샘플 요청
curl -X GET \
https://{{host}}/api/1.1/public/bot/{{BotID}}/publish/status/ \
-H 'Auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
샘플 응답
{
"_id": "ber-xxxxx-xxx-xxx-xxx-xxxxx",
"jobType": "PUBLISH_BOT",
"streamId": "st-xxxxx-xxx-xxx-xxx-xxxxx",
"__v": 0,
"action": "RUN",
"createdBy": "u-xxxxx-xxx-xxx-xxx-xxxxx",
"percentageComplete": 100,
"requestedTime": "2021-12-01T09:19:04.483Z",
"status": "successful",
"lastModifiedOn": "2021-12-01T09:19:05.808Z",
"initiatedOn": "2021-12-01T09:19:04.550Z",
"statusSummary": [
{
"resourceId": "SETTINGS",
"resourceType": "SETTINGS",
"name": "Settings",
"modules": [
"general",
"bot_variables",
"pii",
"ivr",
"hold_resume",
"custom_script",
"advanced"
],
"status": "SUCCESS"
},
{
"resourceId": "NL",
"resourceType": "NL",
"name": "Natural Language",
"modules": [
"nl_model",
"settings"
],
"status": "SUCCESS"
}
]
}
참고 사항: ‘상태’ 필드의 가능한 값은 SUCCESSFUL, FAILED 또는 INPROGRESS입니다.
Leave a Reply
Gets the publish status of the ongoing bot or the last completed status request of the bot. Refer here for initiating Publish Bot API.
To use this API, app needs the Admin API Scope of Publish Status under Bot Publish.
GEThttps://{{host}}/api/public/bot/{{BotID}}/publish/status
Authorization
Invoke the API with JWT in the header with the following syntax:
auth: {{JWT}}
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. |
Response content type
application/json
Sample Request
curl -X GET \
https://{{host}}/api/1.1/public/bot/{{BotID}}/publish/status/ \
-H 'Auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
Sample Response
{
"_id": "ber-xxxxx-xxx-xxx-xxx-xxxxx",
"jobType": "PUBLISH_BOT",
"streamId": "st-xxxxx-xxx-xxx-xxx-xxxxx",
"__v": 0,
"action": "RUN",
"createdBy": "u-xxxxx-xxx-xxx-xxx-xxxxx",
"percentageComplete": 100,
"requestedTime": "2021-12-01T09:19:04.483Z",
"status": "successful",
"lastModifiedOn": "2021-12-01T09:19:05.808Z",
"initiatedOn": "2021-12-01T09:19:04.550Z",
"statusSummary": [
{
"resourceId": "SETTINGS",
"resourceType": "SETTINGS",
"name": "Settings",
"modules": [
"general",
"bot_variables",
"pii",
"ivr",
"hold_resume",
"custom_script",
"advanced"
],
"status": "SUCCESS"
},
{
"resourceId": "NL",
"resourceType": "NL",
"name": "Natural Language",
"modules": [
"nl_model",
"settings"
],
"status": "SUCCESS"
}
]
}
Note: The possible values for the ‘status’ field are – SUCCESSFUL, FAILED or INPROGRESS.