このAPIを使用すると、ボット向けに作成された個々の課金セッションのリストを取得し、それらの正確性と整合性を見直すことができます。.このAPIは、BTおよびBACのアプリスコープで利用可能です。

このAPIを使用するには、課金セッションのボットビルダーAPIスコープがアプリに必要となります。あるいは、ボット分析の課金セッション管理者APIスコープが必要です。

POST Bot Admin Consoleのhttps://{{host}}/api/public/bot/{{BotID}}/getBillingSessionsDetailsとhttps://{{host}}/api/public/getBillingSessionsDetails

クエリパラメータ

パラメータ 説明
host 環境URL、例： https://bots.kore.ai
BotID（ボットビルダースコープで使用する場合） ボットIDまたはストリームID。ボットの「一般設定」ページからアクセスできます。

本文パラメータ

パラメータ 説明
fromDate 日付の形式を選びます yyyy-mm-dd (または) yyyy-mm-ddThh:mm:ss.msZ 例:2019-04-01 (または) 2019-04-01T13:25:58.515Z
toDate 日付の形式を選びます yyyy-mm-dd (または) yyyy-mm-ddThh:mm:ss.msZ eg:2019-04-01 (または) 2019-04-01T13:25:58.515Z最大で6ヶ月間の日付が許可されます
channel（オプション） チャネルコード。
botId（管理者スコープを使用する場合はオプション） ボットIDまたはストリームID。ボットの「一般設定」ページからアクセスできます。

認証

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

応答コンテンツタイプ

application/JSON

サンプルのリクエスト

  • ボットビルダーAPIスコープ 
    curl --location --request POST 'https://{{HOST}}/api/public/bot/{{botId}}/getBillingSessionsDetails' \
--header 'auth: {{Auth Token}}' \
--header 'content-type: application/json' \
--data-raw '{
    "fromDate": "2021-02-21",
    "toDate": "2021-07-22"
}'
  • 管理者APIスコープの場合 
    curl --location --request POST 'https://{{HOST}}/api/public/bots/getBillingSessionsDetails' \
--header 'auth: {{Auth Token}}' \
--header 'content-type: application/json' \
--data-raw '{
    "fromDate": "2021-03-21",
    "toDate": "2021-07-22"
}'

サンプルのレスポンス

{
  "total": 2,
  "sessions":
   [
    {
       "botId": "st-cXaaXXXe-ddXd-XXXX-XbeX-XXXXXcXdXbcX",
       "channel": "IVR",
       "koreUserId": "u-eXXXXXXX-bXfX-XXXc-XXXb-XfXaaXXXXXXX",
       "channelUserId": "XfXXXXXfXXdXcXXXfeXXXdX/ivrvoice/00000152",
       "billingSessionType": "Conversations",
       "conversationSessionId": "XXXXXXbXbXeXXbXcXXfXaXXX",
       "conversationSessionStartDateTime": "03-10-2021 2:05:03 pm",
       "conversationSessionEndDateTime": "03-10-2021 2:05:30 pm",
       "billingSessionId": "XXXXXXbXXXcXXXXcXdXXXXXf",
       "billingSessionStartDateTime": "03-10-2021 2:05:03 pm",
       "billingSessionEndDateTime": "03-10-2021 2:05:30 pm"
   },
   {
       "botId": "st-cXaaXXXe-ddXd-XXXX-XbeX-XXXXXcXdXbcX",
       "channel": "IVR",
       "koreUserId": "u-eXXXXXXX-bXfX-XXXc-XXXb-XfXaaXXXXXXX",
       "channelUserId": "XfXXXXXfXXdXcXXXfeXXXdX/ivrvoice/00000152",
       "billingSessionType": "Conversations",
       "conversationSessionId": "XXXXXXbXbXeXXbXcXXfXaXXX",
       "conversationSessionStartDateTime": "03-10-2021 2:09:02 pm",
       "conversationSessionEndDateTime": "03-10-2021 2:10:17 pm",
       "billingSessionId": "XXXXXXbXXXcXXXXcXdXXXXXf",
       "billingSessionStartDateTime": "03-10-2021 2:09:02 pm",
       "billingSessionEndDateTime": "03-10-2021 2:10:17 pm"
   }
 ]
}

Leave a Reply

Your email address will not be published. Required fields are marked *

Fill out this field
Fill out this field
Please enter a valid email address.
You need to agree with the terms to proceed

이 API는 봇에 대해 생성된 개별 청구 세션 목록을 검색하여 정확성을 확인하고 조정할 수 있도록 합니다. . 이 API는 BT 및 BAC 앱 범위에서 사용할 수 있습니다.

이 API를 사용하려면 앱에 청구 세션의 봇 빌더 API 범위가 필요합니다. 또는 봇 분석 아래의 청구 세션의 관리자 API 범위가 필요합니다.

POST https://{{host}}/api/public/bot/{{BotID}}/getBillingSessionsDetails 및 https://{{host}}/api/public/getBillingSessionsDetails봇 관리자 콘솔의 경우

쿼리 매개 변수

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

본문 매개 변수

매개 변수 설명
fromDate Yyyy-mm-dd 또는 yyyy-mm-ddThh:mm:ss.msZ 형식을 사용합니다(예: 2019-04-01 또는 2019-04-01T13:25:58.515Z)
toDate Yyyy-mm-dd 또는 yyyy-mm-ddThh:mm:ss.msZ 형식을 사용합니다(예: 2019-04-01 또는 2019-04-01T13:25:58.515Z최대 6개월 허용)
channel (선택 사항) 채널 코드입니다.
botId (관리자 범위 사용 시 선택 사항) 봇 ID 또는 스트림 ID. 봇의 일반 설정 페이지에서 이를 액세스할 수 있습니다.

권한 부여

다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다. auth: {{JWT}}

콘텐츠 유형 응답

application/JSON

샘플 요청

  • 봇 빌더 API 범위 
    curl --location --request POST 'https://{{HOST}}/api/public/bot/{{botId}}/getBillingSessionsDetails' \
--header 'auth: {{Auth Token}}' \
--header 'content-type: application/json' \
--data-raw '{
    "fromDate": "2021-02-21",
    "toDate": "2021-07-22"
}'
  • 관리자 API 범위의 경우 
    curl --location --request POST 'https://{{HOST}}/api/public/bots/getBillingSessionsDetails' \
--header 'auth: {{Auth Token}}' \
--header 'content-type: application/json' \
--data-raw '{
    "fromDate": "2021-03-21",
    "toDate": "2021-07-22"
}'

샘플 응답

{
  "total": 2,
  "sessions":
   [
    {
       "botId": "st-cXaaXXXe-ddXd-XXXX-XbeX-XXXXXcXdXbcX",
       "channel": "IVR",
       "koreUserId": "u-eXXXXXXX-bXfX-XXXc-XXXb-XfXaaXXXXXXX",
       "channelUserId": "XfXXXXXfXXdXcXXXfeXXXdX/ivrvoice/00000152",
       "billingSessionType": "Conversations",
       "conversationSessionId": "XXXXXXbXbXeXXbXcXXfXaXXX",
       "conversationSessionStartDateTime": "03-10-2021 2:05:03 pm",
       "conversationSessionEndDateTime": "03-10-2021 2:05:30 pm",
       "billingSessionId": "XXXXXXbXXXcXXXXcXdXXXXXf",
       "billingSessionStartDateTime": "03-10-2021 2:05:03 pm",
       "billingSessionEndDateTime": "03-10-2021 2:05:30 pm"
   },
   {
       "botId": "st-cXaaXXXe-ddXd-XXXX-XbeX-XXXXXcXdXbcX",
       "channel": "IVR",
       "koreUserId": "u-eXXXXXXX-bXfX-XXXc-XXXb-XfXaaXXXXXXX",
       "channelUserId": "XfXXXXXfXXdXcXXXfeXXXdX/ivrvoice/00000152",
       "billingSessionType": "Conversations",
       "conversationSessionId": "XXXXXXbXbXeXXbXcXXfXaXXX",
       "conversationSessionStartDateTime": "03-10-2021 2:09:02 pm",
       "conversationSessionEndDateTime": "03-10-2021 2:10:17 pm",
       "billingSessionId": "XXXXXXbXXXcXXXXcXdXXXXXf",
       "billingSessionStartDateTime": "03-10-2021 2:09:02 pm",
       "billingSessionEndDateTime": "03-10-2021 2:10:17 pm"
   }
 ]
}

Leave a Reply

Your email address will not be published. Required fields are marked *

Fill out this field
Fill out this field
Please enter a valid email address.
You need to agree with the terms to proceed

This API retrieves the list of individual billing sessions created for a bot so that you can review them for correctness and reconciliation. . This API is available in BT and BAC app scopes.

To use this API, an app needs the Bot Builder API scope of Billing Sessions.
OR the Admin API Scope of Billing Sessions under Bot Analytics.

POST https://{{host}}/api/public/bot/{{BotID}}/getBillingSessionsDetails
and https://{{host}}/api/public/getBillingSessionsDetailsfor Bot Admin Console

Query Parameters

Parameter Description
host Environment URL, for example, https://bots.kore.ai
BotID

(when using with Bot Builder scope)

 Bot ID or Stream ID. You can access it from the General Settings page of the bot.

Body Parameters

Parameter Description
fromDate Takes the date format yyyy-mm-dd
(or) yyyy-mm-ddThh:mm:ss.msZ
eg:2019-04-01 (or) 2019-04-01T13:25:58.515Z
toDate Takes the date format yyyy-mm-dd
(or) yyyy-mm-ddThh:mm:ss.msZ
eg:2019-04-01 (or) 2019-04-01T13:25:58.515ZMaximum six month date period allowed
channel (optional) The channel code.
botId (optional when using Admin scope) 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

  • Bot Builder API scope 
    curl --location --request POST 'https://{{HOST}}/api/public/bot/{{botId}}/getBillingSessionsDetails' \
--header 'auth: {{Auth Token}}' \
--header 'content-type: application/json' \
--data-raw '{
    "fromDate": "2021-02-21",
    "toDate": "2021-07-22"
}'
  • For Admin API scope 
    curl --location --request POST 'https://{{HOST}}/api/public/bots/getBillingSessionsDetails' \
--header 'auth: {{Auth Token}}' \
--header 'content-type: application/json' \
--data-raw '{
    "fromDate": "2021-03-21",
    "toDate": "2021-07-22"
}'

Sample Response

{
  "total": 2,
  "sessions":
   [
    {
       "botId": "st-cXaaXXXe-ddXd-XXXX-XbeX-XXXXXcXdXbcX",
       "channel": "IVR",
       "koreUserId": "u-eXXXXXXX-bXfX-XXXc-XXXb-XfXaaXXXXXXX",
       "channelUserId": "XfXXXXXfXXdXcXXXfeXXXdX/ivrvoice/00000152",
       "billingSessionType": "Conversations",
       "conversationSessionId": "XXXXXXbXbXeXXbXcXXfXaXXX",
       "conversationSessionStartDateTime": "03-10-2021 2:05:03 pm",
       "conversationSessionEndDateTime": "03-10-2021 2:05:30 pm",
       "billingSessionId": "XXXXXXbXXXcXXXXcXdXXXXXf",
       "billingSessionStartDateTime": "03-10-2021 2:05:03 pm",
       "billingSessionEndDateTime": "03-10-2021 2:05:30 pm"
   },
   {
       "botId": "st-cXaaXXXe-ddXd-XXXX-XbeX-XXXXXcXdXbcX",
       "channel": "IVR",
       "koreUserId": "u-eXXXXXXX-bXfX-XXXc-XXXb-XfXaaXXXXXXX",
       "channelUserId": "XfXXXXXfXXdXcXXXfeXXXdX/ivrvoice/00000152",
       "billingSessionType": "Conversations",
       "conversationSessionId": "XXXXXXbXbXeXXbXcXXfXaXXX",
       "conversationSessionStartDateTime": "03-10-2021 2:09:02 pm",
       "conversationSessionEndDateTime": "03-10-2021 2:10:17 pm",
       "billingSessionId": "XXXXXXbXXXcXXXXcXdXXXXXf",
       "billingSessionStartDateTime": "03-10-2021 2:09:02 pm",
       "billingSessionEndDateTime": "03-10-2021 2:10:17 pm"
   }
 ]
}

Leave a Reply

Your email address will not be published. Required fields are marked *

Fill out this field
Fill out this field
Please enter a valid email address.
You need to agree with the terms to proceed