Billing Sessions API

この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"
   }
 ]
}

On this Page