{"id":30879,"date":"2021-08-14T07:48:07","date_gmt":"2021-08-14T06:48:07","guid":{"rendered":"https:\/\/developer.kore.ai\/v9-3\/?p=30879"},"modified":"2021-08-14T07:48:07","modified_gmt":"2021-08-14T06:48:07","slug":"billing-sessions-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v9-3\/docs\/bots\/api-guide\/billing-sessions-api\/","title":{"rendered":"Billing Sessions API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

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.<\/p>\n

To use this API, an app needs the Bot Builder API scope of Billing Sessions<\/em>.
\nOR the Admin API Scope of Billing Sessions<\/em>\u00a0under Bot Analytics<\/em>.<\/p>\n

POST<\/strong>\u00a0https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/getBillingSessionsDetails<\/code>
\nand https:\/\/{{host}}\/api\/public\/getBillingSessionsDetails<\/code>for Bot Admin Console<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Query Parameters<\/span><\/h3>\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n
host<\/td>\nEnvironment URL, for example, https:\/\/bots.kore.ai<\/td>\n<\/tr>\n
BotID<\/p>\n

(when using with Bot Builder scope)<\/td>\n

Bot ID or Stream ID. You can access it from the General Settings page of the bot.<\/td>\n<\/tr>\n<\/thead>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n\r\n\t
\r\n\t\t
\r\n\t\t\t

Body Parameters<\/span><\/h3>\n\n\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n
fromDate<\/td>\nTakes the date format yyyy-mm-dd
\n(or) yyyy-mm-ddThh:mm:ss.msZ
\neg:2019-04-01 (or) 2019-04-01T13:25:58.515Z<\/td>\n<\/tr>\n
toDate<\/td>\nTakes the date format yyyy-mm-dd
\n(or) yyyy-mm-ddThh:mm:ss.msZ
\neg:2019-04-01 (or) 2019-04-01T13:25:58.515ZMaximum six month date period allowed<\/td>\n<\/tr>\n
channel (optional)<\/td>\nThe channel code.<\/td>\n<\/tr>\n
botId (optional when using Admin scope)<\/td>\nBot ID or Stream ID. You can access it from the General Settings page of the bot.<\/td>\n<\/tr>\n<\/thead>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Authorization<\/span><\/h3>\n

Invoke the API with JWT in the header with the following syntax:
\nauth: {{JWT}}<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Response content type<\/span><\/h3>\n

application\/JSON<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Sample Request<\/span><\/h3>\n
    \n
  • Bot Builder API scope\n
    curl --location --request POST 'https:\/\/{{HOST}}\/api\/public\/bot\/{{botId}}\/getBillingSessionsDetails' \\\r\n--header 'auth: {{Auth Token}}' \\\r\n--header 'content-type: application\/json' \\\r\n--data-raw '{\r\n    \"fromDate\": \"2021-02-21\",\r\n    \"toDate\": \"2021-07-22\"\r\n}'\r\n<\/pre>\n<\/li>\n
  • For Admin API scope\n
    curl --location --request POST 'https:\/\/{{HOST}}\/api\/public\/bots\/getBillingSessionsDetails' \\\r\n--header 'auth: {{Auth Token}}' \\\r\n--header 'content-type: application\/json' \\\r\n--data-raw '{\r\n    \"fromDate\": \"2021-03-21\",\r\n    \"toDate\": \"2021-07-22\"\r\n}'\r\n<\/pre>\n<\/li>\n<\/ul>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t
    Sample Response<\/span><\/h3>\n
    {\r\n  \"total\": 2,\r\n  \"sessions\":\r\n   [\r\n    {\r\n       \"botId\": \"st-cXaaXXXe-ddXd-XXXX-XbeX-XXXXXcXdXbcX\",\r\n       \"channel\": \"IVR\",\r\n       \"koreUserId\": \"u-eXXXXXXX-bXfX-XXXc-XXXb-XfXaaXXXXXXX\",\r\n       \"channelUserId\": \"XfXXXXXfXXdXcXXXfeXXXdX\/ivrvoice\/00000152\",\r\n       \"billingSessionType\": \"Conversations\",\r\n       \"conversationSessionId\": \"XXXXXXbXbXeXXbXcXXfXaXXX\",\r\n       \"conversationSessionStartDateTime\": \"03-10-2021 2:05:03 pm\",\r\n       \"conversationSessionEndDateTime\": \"03-10-2021 2:05:30 pm\",\r\n       \"billingSessionId\": \"XXXXXXbXXXcXXXXcXdXXXXXf\",\r\n       \"billingSessionStartDateTime\": \"03-10-2021 2:05:03 pm\",\r\n       \"billingSessionEndDateTime\": \"03-10-2021 2:05:30 pm\"\r\n   },\r\n   {\r\n       \"botId\": \"st-cXaaXXXe-ddXd-XXXX-XbeX-XXXXXcXdXbcX\",\r\n       \"channel\": \"IVR\",\r\n       \"koreUserId\": \"u-eXXXXXXX-bXfX-XXXc-XXXb-XfXaaXXXXXXX\",\r\n       \"channelUserId\": \"XfXXXXXfXXdXcXXXfeXXXdX\/ivrvoice\/00000152\",\r\n       \"billingSessionType\": \"Conversations\",\r\n       \"conversationSessionId\": \"XXXXXXbXbXeXXbXcXXfXaXXX\",\r\n       \"conversationSessionStartDateTime\": \"03-10-2021 2:09:02 pm\",\r\n       \"conversationSessionEndDateTime\": \"03-10-2021 2:10:17 pm\",\r\n       \"billingSessionId\": \"XXXXXXbXXXcXXXXcXdXXXXXf\",\r\n       \"billingSessionStartDateTime\": \"03-10-2021 2:09:02 pm\",\r\n       \"billingSessionEndDateTime\": \"03-10-2021 2:10:17 pm\"\r\n   }\r\n ]\r\n}<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"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...","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-30879","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts\/30879","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/comments?post=30879"}],"version-history":[{"count":2,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts\/30879\/revisions"}],"predecessor-version":[{"id":30881,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/posts\/30879\/revisions\/30881"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/media?parent=30879"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/categories?post=30879"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v9-3\/wp-json\/wp\/v2\/tags?post=30879"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}