{"id":30879,"date":"2021-08-14T07:48:07","date_gmt":"2021-08-14T06:48:07","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-3\/?p=30879"},"modified":"2024-03-29T11:18:25","modified_gmt":"2024-03-29T11:18:25","slug":"billing-sessions-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-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.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t\n\n\n\n\n\n\n
Method<\/strong><\/td>\nPOST<\/td>\n<\/tr>\n
Endpoint<\/strong><\/td>\nhttps:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/getBillingSessionsDetails<\/code><\/p>\n

For Bot Admin Console:\u00a0https:\/\/{{host}}\/api\/public\/getBillingSessionsDetails<\/code><\/td>\n<\/tr>\n

Content Type<\/strong><\/td>\napplication\/json<\/code><\/td>\n<\/tr>\n
Authorization<\/strong><\/td>\nauth: {{JWT}}<\/code><\/p>\n

See How to generate the JWT Token.<\/a><\/td>\n<\/tr>\n

API Scope<\/strong><\/td>\n\n
    \n
  • Bot Builder: Billing Sessions<\/li>\n
  • Bot Admin Console: Bot Analytics > Billing Sessions<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Query Parameters<\/span><\/h2>\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
    <\/div>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Body Parameters<\/span><\/h2>\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>\r\n\t
    \r\n\t\t
    \r\n\t\t\t

    Sample Request<\/span><\/h2>\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>\r\n\t
      \r\n\t\t
      \r\n\t\t\t
      Sample Response<\/span><\/h2>\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. Method POST Endpoint https:\/\/{{host}}\/api\/public\/bot\/{{BotID}}\/getBillingSessionsDetails For Bot Admin Console:\u00a0https:\/\/{{host}}\/api\/public\/getBillingSessionsDetails Content Type application\/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Billing Sessions Bot Admin Console: Bot Analytics...","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\/v10-3\/wp-json\/wp\/v2\/posts\/30879","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-3\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-3\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-3\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-3\/wp-json\/wp\/v2\/comments?post=30879"}],"version-history":[{"count":4,"href":"https:\/\/developer.kore.ai\/v10-3\/wp-json\/wp\/v2\/posts\/30879\/revisions"}],"predecessor-version":[{"id":61571,"href":"https:\/\/developer.kore.ai\/v10-3\/wp-json\/wp\/v2\/posts\/30879\/revisions\/61571"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-3\/wp-json\/wp\/v2\/media?parent=30879"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-3\/wp-json\/wp\/v2\/categories?post=30879"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-3\/wp-json\/wp\/v2\/tags?post=30879"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}