This documentation describes the public endpoints of CXone Bot Builder product.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"11749801","collectionId":"9080956e-719c-4b8a-9d83-8f8b82162971","publishedId":"UVypzcuf","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"007CBE"},"publishDate":"2022-03-30T14:26:04.000Z"},"item":[{"name":"Get Conversations","id":"12cccefb-913f-4d31-8de7-438af2e786ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://chatbot-eu1.brandembassy.com/api/public/conversations?token=YOUR TOKEN HERE&query=text=problem&perPage=50&timezone=UTC","urlObject":{"path":["api","public","conversations"],"host":["https://chatbot-eu1.brandembassy.com"],"query":[{"description":{"content":"You can find your token in the Preferences - Import&Export - Conversations section of the Bot Builder app.
\n","type":"text/plain"},"key":"token","value":"YOUR TOKEN HERE"},{"description":{"content":"optional, see https://help.nice-incontact.com/content/aiassistantsandbots/botbuilder/featuredetails/querysearch.htm
\n","type":"text/plain"},"key":"query","value":"text=problem"},{"description":{"content":"optional, default 50, maximum 200
\n","type":"text/plain"},"key":"perPage","value":"50"},{"description":{"content":"optional, default UTC
\n","type":"text/plain"},"key":"timezone","value":"UTC"}],"variable":[]}},"response":[{"id":"0afe0ead-5a4d-4ec6-b579-c3fdbcb07914","name":"Get Conversations","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://chatbot-eu1.brandembassy.com/api/public/conversations?token=YOUR TOKEN HERE&perPage=50","host":["https://chatbot-eu1.brandembassy.com"],"path":["api","public","conversations"],"query":[{"key":"token","value":"YOUR TOKEN HERE","description":"You can find your token in the Preferences section of the Bot Builder app."},{"key":"query","value":"text=problem","description":"optional, see https://help.nice-incontact.com/content/botbuilder/searchfilterconversations.htm","disabled":true},{"key":"perPage","value":"50","description":"optional, default 50, maximum 200"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"chatbot.test"},{"key":"Date","value":"Thu, 31 Mar 2022 09:03:14 GMT"},{"key":"Date","value":"Thu, 31 Mar 2022 09:03:14 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Set-Cookie","value":"laravel_session=eyJpdiI6IkQwalVTazhOaGNmanBkK3R0cXJ3S1E9PSIsInZhbHVlIjoiY2ZkRkM3M1FINWQ4VE5tQmo2WkY3VXZhZlVmQ0xXUWJFNWFxbmtKZ1N2ai83dWgrNWpCQ25sejh5MmRNYUpxelhUTmlSTkJraUF4M0hBRFd1Qk1SREFNTjZpNFZySDREcWsrK0xkOVNOSGwwT042Y3AwcGROaTRUOHh6RjVsRnoiLCJtYWMiOiJlMDRjYmFiYmUwZjkyNWZhZmU0MTM0OThjYTI3NDc2ZGIxMjZlNjNkOWJmNTgxOTRiOWRkMTcxNWI1MTRlNzllIiwidGFnIjoiIn0%3D; expires=Thu, 31-Mar-2022 11:03:14 GMT; Max-Age=7200; path=/; httponly"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"timestamp\": 1648561544204,\n \"conversationId\": \"chat;9J9cjIPRDIQEMrjKRmHO3yHD6ldgE2nLhHW0um51YnUqLCKZV0WO7XmNZ9qC;1ae686af1ba09efab589dafc8f7e9def76edd3b6\",\n \"customer\": {\n \"id\": \"\",\n \"name\": \"Test User\"\n },\n \"channel\": {\n \"id\": \"\",\n \"name\": \"Talk to your bot\",\n \"icon\": \"\"\n },\n \"isReviewed\": false,\n \"dfo\": {\n \"caseId\": \"\",\n \"postId\": \"\"\n },\n \"conversationNumber\": 2,\n \"tags\": [],\n \"notes\": \"\",\n \"msgCount\": 2,\n \"tracker\": {\n \"name\": \"1-chat;9J9cjIPRDIQEMrjKRmHO3yHD6ldgE2nLhHW0um51YnUqLCKZV0WO7XmNZ9qC;1ae686af1ba09efab589dafc8f7e9def76edd3b6\",\n \"events\": [\n {\n \"action_text\": null,\n \"confidence\": 1,\n \"name\": \"action_session_start\",\n \"event\": \"action\",\n \"timestamp\": 1648561512.2565417,\n \"policy\": null\n },\n {\n \"event\": \"session_started\",\n \"timestamp\": 1648561512.2569168\n },\n {\n \"action_text\": null,\n \"confidence\": null,\n \"name\": \"action_listen\",\n \"event\": \"action\",\n \"timestamp\": 1648561512.2569668,\n \"policy\": null\n },\n {\n \"name\": \"last customer message\",\n \"event\": \"slot\",\n \"value\": \"hey man\",\n \"timestamp\": 1648561544\n },\n {\n \"input_channel\": \"rest\",\n \"metadata\": [],\n \"parse_data\": {\n \"metadata\": [],\n \"entities\": [],\n \"intent_ranking\": [\n {\n \"confidence\": 0.9985595941543579,\n \"name\": \"greet\",\n \"id\": 8799647739638427006\n },\n {\n \"confidence\": 0.001255965093150735,\n \"name\": \"bot_challenge\",\n \"id\": 537165732299237766\n },\n {\n \"confidence\": 0.00011412458115955815,\n \"name\": \"deny\",\n \"id\": 7789276621464026164\n },\n {\n \"confidence\": 0.000042451079934835434,\n \"name\": \"mood_happy\",\n \"id\": -584438451177453247\n },\n {\n \"confidence\": 0.000012655452337639872,\n \"name\": \"affirm\",\n \"id\": 1699228255164209795\n },\n {\n \"confidence\": 0.000011626671948761214,\n \"name\": \"mood_unhappy\",\n \"id\": -2824675948439799632\n },\n {\n \"confidence\": 0.0000036243095564714167,\n \"name\": \"goodbye\",\n \"id\": -7118454194143129684\n }\n ],\n \"message_id\": \"5e1b304f5eea49119c7351b5d40e0601\",\n \"text\": \"hey man\",\n \"intent\": {\n \"confidence\": 0.9985595941543579,\n \"name\": \"greet\",\n \"id\": 8799647739638427006\n },\n \"response_selector\": {\n \"default\": {\n \"response\": {\n \"template_name\": \"utter_None\",\n \"response_templates\": null,\n \"confidence\": 0,\n \"responses\": null,\n \"id\": null,\n \"utter_action\": \"utter_None\",\n \"intent_response_key\": null\n },\n \"ranking\": []\n },\n \"all_retrieval_intents\": []\n }\n },\n \"message_id\": \"5e1b304f5eea49119c7351b5d40e0601\",\n \"text\": \"hey man\",\n \"event\": \"user\",\n \"timestamp\": 1648561512.2947981\n },\n {\n \"use_text_for_featurization\": false,\n \"event\": \"user_featurization\",\n \"timestamp\": 1648561512.3147433\n },\n {\n \"action_text\": null,\n \"confidence\": 1,\n \"name\": \"utter_cb9093ad010c8c1fa61d276921b1429315122af4\",\n \"event\": \"action\",\n \"timestamp\": 1648561512.3147886,\n \"policy\": \"policy_2_RulePolicy\"\n },\n {\n \"metadata\": {\n \"utter_action\": \"utter_cb9093ad010c8c1fa61d276921b1429315122af4\"\n },\n \"data\": {\n \"image\": null,\n \"buttons\": null,\n \"attachment\": null,\n \"elements\": null,\n \"quick_replies\": null,\n \"custom\": null\n },\n \"text\": \"Hey! How are you?\",\n \"event\": \"bot\",\n \"timestamp\": 1648561512.315328\n },\n {\n \"action_text\": null,\n \"confidence\": 1,\n \"name\": \"action_listen\",\n \"event\": \"action\",\n \"timestamp\": 1648561512.328118,\n \"policy\": \"policy_2_RulePolicy\"\n }\n ]\n }\n },\n {\n \"timestamp\": 1648561523996,\n \"conversationId\": \"chat;uie3dptvgmpSPG74ZisBugev0l741b8s0Ah3gTYDlifCSZBg1YZnqFEhSiId;65dfb9d0f00789e7d0665d09b9e938d591899e37\",\n \"customer\": {\n \"id\": \"\",\n \"name\": \"Test User\"\n },\n \"channel\": {\n \"id\": \"\",\n \"name\": \"Talk to your bot\",\n \"icon\": \"\"\n },\n \"isReviewed\": false,\n \"dfo\": {\n \"caseId\": \"\",\n \"postId\": \"\"\n },\n \"conversationNumber\": 1,\n \"tags\": [],\n \"notes\": \"\",\n \"msgCount\": 4,\n \"tracker\": {\n \"name\": \"1-chat;uie3dptvgmpSPG74ZisBugev0l741b8s0Ah3gTYDlifCSZBg1YZnqFEhSiId;65dfb9d0f00789e7d0665d09b9e938d591899e37\",\n \"events\": [\n {\n \"action_text\": null,\n \"confidence\": 1,\n \"name\": \"action_session_start\",\n \"event\": \"action\",\n \"timestamp\": 1648561492.1851382,\n \"policy\": null\n },\n {\n \"event\": \"session_started\",\n \"timestamp\": 1648561492.1856515\n },\n {\n \"action_text\": null,\n \"confidence\": null,\n \"name\": \"action_listen\",\n \"event\": \"action\",\n \"timestamp\": 1648561492.18575,\n \"policy\": null\n },\n {\n \"name\": \"last customer message\",\n \"event\": \"slot\",\n \"value\": \"zirafa\",\n \"timestamp\": 1648561524\n },\n {\n \"input_channel\": \"rest\",\n \"metadata\": [],\n \"parse_data\": {\n \"metadata\": [],\n \"entities\": [],\n \"intent_ranking\": [\n {\n \"confidence\": 0.7804142236709595,\n \"name\": \"mood_happy\",\n \"id\": -584438451177453247\n },\n {\n \"confidence\": 0.06920244544744492,\n \"name\": \"affirm\",\n \"id\": 1699228255164209795\n },\n {\n \"confidence\": 0.06637383997440338,\n \"name\": \"mood_unhappy\",\n \"id\": -2824675948439799632\n },\n {\n \"confidence\": 0.044616587460041046,\n \"name\": \"deny\",\n \"id\": 7789276621464026164\n },\n {\n \"confidence\": 0.024387067183852196,\n \"name\": \"greet\",\n \"id\": 8799647739638427006\n },\n {\n \"confidence\": 0.010758675634860992,\n \"name\": \"goodbye\",\n \"id\": -7118454194143129684\n },\n {\n \"confidence\": 0.004247196018695831,\n \"name\": \"bot_challenge\",\n \"id\": 537165732299237766\n }\n ],\n \"message_id\": \"8d997a50369d40629470253ed9f47efc\",\n \"text\": \"zirafa\",\n \"intent\": {\n \"confidence\": 0.7804142236709595,\n \"name\": \"mood_happy\",\n \"id\": -584438451177453247\n },\n \"response_selector\": {\n \"default\": {\n \"response\": {\n \"template_name\": \"utter_None\",\n \"response_templates\": null,\n \"confidence\": 0,\n \"responses\": null,\n \"id\": null,\n \"utter_action\": \"utter_None\",\n \"intent_response_key\": null\n },\n \"ranking\": []\n },\n \"all_retrieval_intents\": []\n }\n },\n \"message_id\": \"8d997a50369d40629470253ed9f47efc\",\n \"text\": \"zirafa\",\n \"event\": \"user\",\n \"timestamp\": 1648561492.2771978\n },\n {\n \"use_text_for_featurization\": false,\n \"event\": \"user_featurization\",\n \"timestamp\": 1648561492.2926836\n },\n {\n \"action_text\": null,\n \"confidence\": 1,\n \"name\": \"utter_a1d20b921fb25d7b69787dbe26049ac4509a591b\",\n \"event\": \"action\",\n \"timestamp\": 1648561492.2927423,\n \"policy\": \"policy_0_AugmentedMemoizationPolicy\"\n },\n {\n \"metadata\": {\n \"utter_action\": \"utter_a1d20b921fb25d7b69787dbe26049ac4509a591b\"\n },\n \"data\": {\n \"image\": null,\n \"buttons\": null,\n \"attachment\": null,\n \"elements\": null,\n \"quick_replies\": null,\n \"custom\": null\n },\n \"text\": \"Great, carry on!\",\n \"event\": \"bot\",\n \"timestamp\": 1648561492.2936282\n },\n {\n \"action_text\": null,\n \"confidence\": 1,\n \"name\": \"action_listen\",\n \"event\": \"action\",\n \"timestamp\": 1648561492.307178,\n \"policy\": \"policy_0_AugmentedMemoizationPolicy\"\n },\n {\n \"name\": \"last customer message\",\n \"event\": \"slot\",\n \"value\": \"hey\",\n \"timestamp\": 1648561531\n },\n {\n \"input_channel\": \"rest\",\n \"metadata\": [],\n \"parse_data\": {\n \"metadata\": [],\n \"entities\": [],\n \"intent_ranking\": [\n {\n \"confidence\": 0.9999918937683105,\n \"name\": \"greet\",\n \"id\": 8799647739638427006\n },\n {\n \"confidence\": 0.000003899609055224573,\n \"name\": \"mood_happy\",\n \"id\": -584438451177453247\n },\n {\n \"confidence\": 0.0000022245362742978614,\n \"name\": \"deny\",\n \"id\": 7789276621464026164\n },\n {\n \"confidence\": 0.0000010077415026898962,\n \"name\": \"bot_challenge\",\n \"id\": 537165732299237766\n },\n {\n \"confidence\": 7.771302534820279e-7,\n \"name\": \"affirm\",\n \"id\": 1699228255164209795\n },\n {\n \"confidence\": 1.3844379509464488e-7,\n \"name\": \"goodbye\",\n \"id\": -7118454194143129684\n },\n {\n \"confidence\": 7.593693851504213e-8,\n \"name\": \"mood_unhappy\",\n \"id\": -2824675948439799632\n }\n ],\n \"message_id\": \"964619ae2a3b42ea95fcef38c7e464c2\",\n \"text\": \"hey\",\n \"intent\": {\n \"confidence\": 0.9999918937683105,\n \"name\": \"greet\",\n \"id\": 8799647739638427006\n },\n \"response_selector\": {\n \"default\": {\n \"response\": {\n \"template_name\": \"utter_None\",\n \"response_templates\": null,\n \"confidence\": 0,\n \"responses\": null,\n \"id\": null,\n \"utter_action\": \"utter_None\",\n \"intent_response_key\": null\n },\n \"ranking\": []\n },\n \"all_retrieval_intents\": []\n }\n },\n \"message_id\": \"964619ae2a3b42ea95fcef38c7e464c2\",\n \"text\": \"hey\",\n \"event\": \"user\",\n \"timestamp\": 1648561499.7394948\n },\n {\n \"use_text_for_featurization\": false,\n \"event\": \"user_featurization\",\n \"timestamp\": 1648561499.7561657\n },\n {\n \"action_text\": null,\n \"confidence\": 1,\n \"name\": \"utter_cb9093ad010c8c1fa61d276921b1429315122af4\",\n \"event\": \"action\",\n \"timestamp\": 1648561499.7562041,\n \"policy\": \"policy_2_RulePolicy\"\n },\n {\n \"metadata\": {\n \"utter_action\": \"utter_cb9093ad010c8c1fa61d276921b1429315122af4\"\n },\n \"data\": {\n \"image\": null,\n \"buttons\": null,\n \"attachment\": null,\n \"elements\": null,\n \"quick_replies\": null,\n \"custom\": null\n },\n \"text\": \"Hey! How are you?\",\n \"event\": \"bot\",\n \"timestamp\": 1648561499.7566245\n },\n {\n \"action_text\": null,\n \"confidence\": 1,\n \"name\": \"action_listen\",\n \"event\": \"action\",\n \"timestamp\": 1648561499.7742262,\n \"policy\": \"policy_2_RulePolicy\"\n }\n ]\n }\n }\n ],\n \"per_page\": 50,\n \"total\": 2,\n \"path\": \"http://chatbot.test/ajax/bot/elastic/conversations\",\n \"next_page_url\": \"\"\n}"}],"_postman_id":"12cccefb-913f-4d31-8de7-438af2e786ff"}],"event":[{"listen":"prerequest","script":{"id":"18826662-f889-4424-b2e7-538e1ceb89ac","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"31c0772f-986c-4780-bfc5-238672bb71e9","type":"text/javascript","exec":[""]}}],"variable":[{"key":"APP_URL","value":"https://chatbot-eu1.brandembassy.com","type":"string"}]}