특정 대화의 디버그 로그를 가져옵니다(현재 IVR 채널에 대해서만 지원됨).
이 API를 사용하려면 앱에 디버그 로그의 봇 빌더 API 범위가 필요합니다.
GET https://{{host}}/api/{{version}/{{BotID}}/debuglogs?identity={{identity}}&channelType={{channelType}}&minimumInfo=true&limit=5&offset=300&timezone={{timezone}}
| 매개 변수 | 설명 |
|---|---|
| host | 환경 URL, 예: https://bots.kore.ai |
| version | API 버전을 참조합니다. 이 API의 현재 버전은 "1.1"입니다. |
| BotID | 봇 ID 또는 스트림 ID. 봇의 일반 설정 페이지에서 이를 액세스할 수 있습니다. |
| identity | 호출에 연결된 고유 ID입니다. |
| channelType | 현재 지원되는 채널은 "ivrVoice" |
| minimumInfo | 선택 필드입니다. 요약만 가져오려면 "true"로 설정 |
| offset | 로그 가져오기를 시작할 페이지 번호를 지정합니다. 지정하지 않으면 로그 목록의 첫 번째 페이지인 0부터 시작됩니다 |
| limit | 가져올 레코드 수입니다. 적용할 수 있는 최대한도는 50입니다 |
| timezone | 예: America/New_York |
| fromDate | 로그가 요청된 날짜, 유효한 형식 – yyyy-mm-dd 또는 유효한 타임스탬프 |
| toDate | 로그가 요청된 날짜, 유효한 형식 – yyyy-mm-dd 또는 유효한 타임스탬프 |
다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다. auth: {{JWT}}
application/json
curl -X GET \
https://{{host}}/api/1.1/{{BotID}}/debuglogs?identity={{id}}&channelType=ivrVoice&minimumInfo=true&limit=5&offset=300&timezone=America/New_York' \
-H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
[
{
"timestamp": "2018-11-22T13:06:17.258Z",
"nomatch_count": "0",
"noinput_count": "1",
"debugTitle": "Bing",
"debugLevel": "Info",
"debugMessage": "intent node initiated",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"timestamp": "2018-11-22T13:06:17.258Z",
"debugTitle": "Bing",
"debugLevel": "Info",
"debugMessage": "intent node processing is completed",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"timestamp": "2018-11-22T13:06:17.258Z",
"debugTitle": "Nam",
"debugLevel": "Info",
"debugMessage": "entity node initiated",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"timestamp": "2018-11-22T13:06:17.258Z",
"debugTitle": "Nam",
"debugLevel": "Info",
"debugMessage": "Waiting for user input",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"debugTitle": "Nam",
"debugMessage": "User prompt parsing",
"debugLevel": "info",
"timestamp": "2018-11-22T13:06:17.304Z",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"debugTitle": "Nam",
"debugMessage": "User prompt parsing successful",
"debugLevel": "info",
"debugDetail": "\"Let me know your name\\n\"",
"timestamp": "2018-11-22T13:06:17.325Z",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"timestamp": "2018-11-22T13:06:31.464Z",
"nomatch_count": "2",
"noinput_count": "0",
"debugTitle": "Nam",
"debugLevel": "Warning",
"debugMessage": "executeNode has invoked due to MAX_NO_MATCH event",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"timestamp": "2018-11-22T13:07:54.395Z",
"debugTitle": "Company: Reached end of dialog",
"debugLevel": "Info",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
}
]
特定の会話のデバッグログを取得（現在はIVRチャネルのみサポート）。
このAPIを使用するためには、アプリにデバッグログのボットビルダーAPIスコープが必要となります。
GET https://{{host}}/api/{{version}/{{BotID}}/debuglogs?identity={{identity}}&channelType={{channelType}}&minimumInfo=true&limit=5&offset=300&timezone={{timezone}}
| パラメータ | 説明 |
|---|---|
| host | 環境URL、例： https://bots.kore.ai |
| version | APIのバージョンをご覧ください。このAPIの現在のバージョンは「1.1」です。 |
| BotID | ボットIDまたはストリームID。ボットの「一般設定」ページからアクセスできます。 |
| identity | 呼び出しに関連付けられた固有のID。 |
| channelType | ivrVoiceの現在サポートされているチャンネル |
| minimumInfo | オプションのフィールド。サマリーのみを手に入れるためには、「true」に設定します。 |
| offset | ログの取得の開始ページ番号を指定します。指定がない場合は、0から始まり、これがログリストの最初のページとなります。 |
| limit | 取得する記録の数です。適用上限値は50です |
| timezone | 例：America/New_York |
| fromDate | ログがリクエストされた日付、有効な形式は yyyy-mm-dd または有効なタイムスタンプ |
| toDate | ログがリクエストされた日付、有効な形式は yyyy-mm-dd または有効なタイムスタンプ |
ヘッダー内のJWTを含むAPIを、以下の構文で呼び出します。 auth: {{JWT}}
application/json
curl -X GET \
https://{{host}}/api/1.1/{{BotID}}/debuglogs?identity={{id}}&channelType=ivrVoice&minimumInfo=true&limit=5&offset=300&timezone=America/New_York' \
-H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
[
{
"timestamp": "2018-11-22T13:06:17.258Z",
"nomatch_count": "0",
"noinput_count": "1",
"debugTitle": "Bing",
"debugLevel": "Info",
"debugMessage": "intent node initiated",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"timestamp": "2018-11-22T13:06:17.258Z",
"debugTitle": "Bing",
"debugLevel": "Info",
"debugMessage": "intent node processing is completed",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"timestamp": "2018-11-22T13:06:17.258Z",
"debugTitle": "Nam",
"debugLevel": "Info",
"debugMessage": "entity node initiated",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"timestamp": "2018-11-22T13:06:17.258Z",
"debugTitle": "Nam",
"debugLevel": "Info",
"debugMessage": "Waiting for user input",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"debugTitle": "Nam",
"debugMessage": "User prompt parsing",
"debugLevel": "info",
"timestamp": "2018-11-22T13:06:17.304Z",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"debugTitle": "Nam",
"debugMessage": "User prompt parsing successful",
"debugLevel": "info",
"debugDetail": "\"Let me know your name\\n\"",
"timestamp": "2018-11-22T13:06:17.325Z",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"timestamp": "2018-11-22T13:06:31.464Z",
"nomatch_count": "2",
"noinput_count": "0",
"debugTitle": "Nam",
"debugLevel": "Warning",
"debugMessage": "executeNode has invoked due to MAX_NO_MATCH event",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"timestamp": "2018-11-22T13:07:54.395Z",
"debugTitle": "Company: Reached end of dialog",
"debugLevel": "Info",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
}
]
To get debug logs of a specific conversation (currently supported only for IVR Channel).
To use this API, app needs the Bot Builder API scope of Debug Logs.
GET https://{{host}}/api/{{version}/{{BotID}}/debuglogs?identity={{identity}}&channelType={{channelType}}&minimumInfo=true&limit=5&offset=300&timezone={{timezone}}
| Parameter | Description |
|---|---|
| host | Environment URL, for example, https://bots.kore.ai |
| version | Refers to the version of the API. The current version of this API is “1.1” |
| BotID | Bot ID or Stream ID. You can access it from the General Settings page of the bot. |
| identity | Unique ID associated with the call. |
| channelType | “ivrVoice” currently supported channel |
| minimumInfo | Optional field. Set to “true” to get only the summary |
| offset | Specify the page number from which to start fetching the logs. If unspecified, it starts from 0, which is the first page of the list of logs |
| limit | The number of records to fetch. The maximum applicable limit is 50 |
| timezone | Ex: America/New_York |
| fromDate | Date from which the logs are requested, valid formats – yyyy-mm-dd or valid timestamp |
| toDate | Date up to which the logs are requested, valid formats – yyyy-mm-dd or valid timestamp |
Invoke the API with JWT in the header with the following syntax:
auth: {{JWT}}
application/json
curl -X GET \
https://{{host}}/api/1.1/{{BotID}}/debuglogs?identity={{id}}&channelType=ivrVoice&minimumInfo=true&limit=5&offset=300&timezone=America/New_York' \
-H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
[
{
"timestamp": "2018-11-22T13:06:17.258Z",
"nomatch_count": "0",
"noinput_count": "1",
"debugTitle": "Bing",
"debugLevel": "Info",
"debugMessage": "intent node initiated",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"timestamp": "2018-11-22T13:06:17.258Z",
"debugTitle": "Bing",
"debugLevel": "Info",
"debugMessage": "intent node processing is completed",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"timestamp": "2018-11-22T13:06:17.258Z",
"debugTitle": "Nam",
"debugLevel": "Info",
"debugMessage": "entity node initiated",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"timestamp": "2018-11-22T13:06:17.258Z",
"debugTitle": "Nam",
"debugLevel": "Info",
"debugMessage": "Waiting for user input",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"debugTitle": "Nam",
"debugMessage": "User prompt parsing",
"debugLevel": "info",
"timestamp": "2018-11-22T13:06:17.304Z",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"debugTitle": "Nam",
"debugMessage": "User prompt parsing successful",
"debugLevel": "info",
"debugDetail": "\"Let me know your name\\n\"",
"timestamp": "2018-11-22T13:06:17.325Z",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"timestamp": "2018-11-22T13:06:31.464Z",
"nomatch_count": "2",
"noinput_count": "0",
"debugTitle": "Nam",
"debugLevel": "Warning",
"debugMessage": "executeNode has invoked due to MAX_NO_MATCH event",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
},
{
"timestamp": "2018-11-22T13:07:54.395Z",
"debugTitle": "Company: Reached end of dialog",
"debugLevel": "Info",
"metaInfo": {
"channel": "ivrVoice",
"identity": "Nov22PilotEnv1"
}
}
]