機器人產生器對話 API

對話 API 允許您匯出機器人產生器對話資料。聯絡人姓名、對話 ID、通道Closed 聯絡人與客服專員或機器人互動的方式。通道可以是語音、電郵、聊天、社交媒體等等。、意圖Closed 聯絡人所說/所輸入內容背後的含義或目的；聯絡要傳達或實現什麼 和訊息內容等資料將被提取。您可以對匯出的資料進行分析或使用其他第三方流程。

URL

https://bot-builder-de-[region].niceincontact.com/api/public/conversations

在 URL 中，將 [region] 替換為CXone系統運行所在的區域，如na1。CXone開發者入口網站中的文件介紹如何確定您的區域一個正方形圖示，箭頭從中心向外指向右上角。。

方法

GET

授權

使用在機器人產生器中的「首選項」>「匯入和匯出」標籤中找到的權杖，用於要從中提取對話資料的機器人。權杖位於「對話」部分。

成功回應

代碼：200 OK

參數

金鑰 定義
token

從機器人產生器獲取的授權權杖。
query

用於篩選結果的查詢字串。使用機器人產生器支援的查詢參數構建查詢。
perPage

每頁顯示的結果數。

預設值為 50。最大值為 200。這是一個可選參數。1719943427.00907
timezone

回應中時間戳的預設時區是 UTC。若要將時間戳轉換為不同的時區，請使用此參數並指定新的時區。這是一個可選參數。

回應標題

金鑰 定義
Host 請求傳送到的網域名稱。

Date

傳送回應的日期和時間。
Connection 指示當前回應完成時網路連線是保持開啟或關閉。
X-Powered-By 有關伺服器的資訊，例如正在使用的軟體。
Cache-Control 指定請求和回應中的瀏覽器快取政策。
Content-Type 回應正文中傳送的資源的媒體類型。
Set-Cookie 在接收回應的系統中建立一個 cookie。

回應欄位

金鑰 子金鑰 類型 定義
data   陣列 有關詳細資訊，請參閱資料陣列。
per_page   數字 每頁的記錄數，如perPage請求參數中指定。
total   數字 匯出中的對話總數。
count   數字 目前頁面上的對話數。
path   字串 正在呼叫的 API 的 URL。
next_page_url   字串 下一頁資料的 URL（如果有）。
scroll_id   字串 用於從單一搜尋請求中檢索更多批次結果的 ID。

資料陣列

存儲對話資料的物件數組。

金鑰 子金鑰 類型 定義
timestamp   數字 對話發生的時間。
conversationId   字串 機器人產生器中對話的 ID。
customer   物件 存儲有關聯絡人的資料。
  id 數字？ 機器人產生器對話資料中聯絡人的 ID。
  name 字串 聯絡人的名稱。
channel   物件 存儲有關發生對話的通道的資料。
  id 數字 發生對話的通道的 ID。
  name 字串 發生對話的通道的名稱。
  icon   發生對話的通道的相關圖示。
isReviewed   布爾 指示對話是否已在機器人產生器的「對話」標籤上進行審核。
dfo   物件 在Digital Experience中存儲對話的案例和帖子 ID。
  caseId 數字？ 來自Digital Experience的案例。
  postId 數字？ 來自Digital Experience的帖子 ID。
conversationNumber   數字 在機器人產生器中的「見解」>「對話」標籤上指派給對話的數字 ID。
tags   陣列 套用於對話的標籤陣列。
notes   字串 與對話相關的備註。
msgCount   數字 對話中的訊息數。
tracker   物件 包含有關對話期間所發生事件的資料的物件。事件的具體內容因對話而異。

請求範例

curl --location 'https://chatbot-eu1.brandembassy.com/api/public/conversations?token=YOUR TOKEN HERE&perPage=50'

回應範例

標題

金鑰 範例值
Host chatbot.test

Date

Thu, 31 Mar 2022 09:03:14 GMT >
Connection close
X-Powered-B PHP/7.4.28
Cache-Control no-cache, private
Content-Type application/json
Set-Cookie laravel_session=eyJpdiI6IkQwalVTazhOaGNmanBkK3R0cXJ3S1E9PSIsInZhbH
VlIjoiY2ZkRkM3M1FINWQ4VE5tQmo2WkY3VXZhZlVmQ0xXUWJFNWFxbmtKZ1N2ai83dW
grNWpCQ25sejh5MmRNYUpxelhUTmlSTkJraUF4M0hBRFd1Qk1SREFNTjZpNFZySDREc
WsrK0xkOVNOSGwwT042Y3AwcGROaTRUOHh6RjVsRnoiLCJtYWMiOiJlMDRjYmFiYmUw
ZjkyNWZhZmU0MTM0OThjYTI3NDc2ZGIxMjZlNjNkOWJmNTgxOTRiOWRkMTcxNWI1MTRl
NzllIiwidGFnIjoiIn0%3D; expires=Thu, 31-Mar-2022 11:03:14 GMT; Max-Age=7200; path=/; httponly

正文

{
"data": [
 {
  "timestamp": 1719943426916,
  "conversationId": "chat;wOT4JjXiVYwsgqUaOX3VHpCQd3OzYpXZqJfCK7yzIQzTofYJh4BvD6RuB4De;df3323db2a5ca2b95767dba4fdafbeb1e31ed899",
  "customer": {
   "id": "Anne Shirley",
   "name": "Anne Shirley"
  },
  "channel": {
   "id": "",
   "name": "Talk to your bot",
   "icon": ""
  },
  "isReviewed": true,
  "dfo": {
   "caseId": "",
   "postId": ""
  },
  "conversationNumber": 13,
  "tags": [],
  "notes": "",
  "msgCount": 8,
  "customerMsgCount": 4,
  "botMsgCount": 4,
  "tracker": {
   "name": "1327-chat;wOT4JjXiVYwsgqUaOX3VHpCQd3OzYpXZqJfCK7yzIQzTofYJh4BvD6RuB4De;df3323db2a5ca2b95767dba4fdafbeb1e31ed899",
   "events": [
    {
	 "metadata": {
	  "model_id": "e3446bf187254f30b008e14cd2c003fa"
	 },
	 action_text": null,
	 "hide_rule_turn": false,
	 "confidence": 1,
	 "name": "action_session_start",
	 "event": "action",
	 "type": "session_start",
	 "timestamp": 1719943427.00903,
	 "policy": null
	},
	{
	 "metadata": {
	  "model_id": "e3446bf187254f30b008e14cd2c003fa"
	 },
	 "event": "session_started",
	 "timestamp": 1719943427.00907
    },
    {
    "metadata": {
	 "model_id": "e3446bf187254f30b008e14cd2c003fa"
    },
    "action_text": null,
    "hide_rule_turn": false,
    "confidence": null,
    "name": "action_listen",
    "event": "action",
    "type": "listen",
    "timestamp": 1719943427.00909,
    "policy": null
   },
   {
    "metadata": {
	 "model_id": "e3446bf187254f30b008e14cd2c003fa"
	},
	"name": "last customer message",
	"event": "slot",
	"value": "Hi",
	"timestamp": 1719943426
   },
   {
    "input_channel": "rest",
	"metadata": {
	 "model_id": "e3446bf187254f30b008e14cd2c003fa"
	},
	"parse_data": {
	 "metadata": [],
	 "entities": [],
	 "intent_ranking": [
	 {
	  "confidence": 0.999254524707794,
	  "name": "greetings"
	 },
	 {
	  "confidence": 0.000439087860286235,
	  "name": "disagree"
	 },
     {
	  "confidence": 0.000150558917084708,
	  "name": "Password_reset"
	 },
	 {
	  "confidence": 0.0000576797829126,
	  "name": "account_trouble"
	 },
	 {
	  "confidence": 0.000042040039261337,
	  "name": "relief"
	 },
	 {
	  "confidence": 0.000033947151678148,
	  "name": "thanks"
	 },
	 {
	  "confidence": 0.000020435854821698,
	  "name": "agree"
	 },
	 {
	  "confidence": 0.000001789070665836,
	  "name": "goodbyes"
	 }
	],
	"message_id": "454bd66a26b740bebf01b6cbb8ea055f",
	"text": "Hi",
	"text_tokens": [
	 [0, 2]
	],
	"intent": {
	 "confidence": 0.999254524707794,
	 "name": "greetings"
	},
	"response_selector": {
	 "default": {
	  "response": {
	   "confidence": 0,
	   "responses": null,
	   "utter_action": "utter_None",
	   "intent_response_key": null
	  },
	  "ranking": []
	 },
	 "all_retrieval_intents": []
	}
   },
   "message_id": "454bd66a26b740bebf01b6cbb8ea055f",
   "text": "Hi",
   "event": "user",
   "timestamp": 1719943427.02725
  },
  {
   "metadata": {
    "model_id": "e3446bf187254f30b008e14cd2c003fa"
   },
   "name": "yesOrno",
   "event": "slot",
   "value": "Hi",
   "timestamp": 1719943427.02793
  },
  {
   "metadata": {
    "model_id": "e3446bf187254f30b008e14cd2c003fa"
   },
   "use_text_for_featurization": false,
   "event": "user_featurization",
   "timestamp": 1719943427.07373
  },
  {
   "metadata": {
    "model_id": "e3446bf187254f30b008e14cd2c003fa"
   },
   "action_text": null,
   "hide_rule_turn": true,
   "confidence": 1,
   "name": "utter_eyJoYXNoIjoiYmE2ZGM2OTJjNDc1YmNkNTA0NjEyZjZiZjdkMTg5M2E3MmJiMmQ2NiIsInRpZCI6Mjc0MjAsInR5cGUiOiJtZXNzYWdlIn0=",
   "event": "action",
   "timestamp": 1719943427.07374,
   "policy": "RulePolicy"
  },
  {
   "metadata": {
    "model_id": "e3446bf187254f30b008e14cd2c003fa",
	"utter_action": "utter_eyJoYXNoIjoiYmE2ZGM2OTJjNDc1YmNkNTA0NjEyZjZiZjdkMTg5M2E3MmJiMmQ2NiIsInRpZCI6Mjc0MjAsInR5cGUiOiJtZXNzYWdlIn0="
   },
  "data": {
   "image": null,
   "buttons": null,
   "attachment": null,
   "elements": null,
   "quick_replies": null,
   "custom": {
    "payload": {
	 "buttons": [],
	 "text": "Hi, what can I help with?"
	},
   "fallback_text": ""
  }
 },
 "text": null,
 "event": "bot",
 "timestamp": 1719943427.07381
},
{
 "metadata": {
  "model_id": "e3446bf187254f30b008e14cd2c003fa"
 },
 "action_text": null, 
 "hide_rule_turn": true,
 "confidence": 1,
  "name": "action_listen",
  "event": "action",
  "type": "listen",
  "timestamp": 1719943427.07791,
  "policy": "RulePolicy"
 },
 {
  "metadata": {
   "model_id": "e3446bf187254f30b008e14cd2c003fa"
  },
  "name": "last customer message",
  "event": "slot",
  "value": "I'm at the Columbus office.",
  "timestamp": 1719943437
 },
 {
  "input_channel": "rest",
  "metadata": {
   "model_id": "e3446bf187254f30b008e14cd2c003fa"
  },
  "parse_data": {
   "metadata": [],
   "entities": [],
   "intent_ranking": [
    {
	 "confidence": 0.99,
	 "name": "nlu_fallback"
	},
	{
	 "confidence": 0.838853657245636,
	 "name": "relief"
	},
	{
	 "confidence": 0.0788173228502274,
	 "name": "thanks"
	},
	{
	 "confidence": 0.0539873205125332,
	 "name": "account_trouble"
	},
	{
	 "confidence": 0.0121194049715996,
	 "name": "agree"
	},
	{
	 "confidence": 0.00501278694719076,
	 "name": "disagree"
	},
	{
	 "confidence": 0.00474171573296189,
	 "name": "goodbyes"
	},
	{
	 "confidence": 0.00369063019752502,
	 "name": "Password_reset"
	},
	{
	 "confidence": 0.00277714524418116,
	 "name": "greetings"
	}
   ],
   "message_id": "f57ad5efaabc49e9b80a5ad5d1c54e40",
   "text": "I'm at the Columbus office.",
   "text_tokens": [
    [0, 1],
	[2, 3],
	[4, 6],
	[7, 10],
	[11, 19],
	[20, 26]
   ],
   "intent": {
	"confidence": 0.99,
	"name": "nlu_fallback"
   },
   "response_selector": {
    "default": {
	 "response": {
	   "confidence": 0,
	   "responses": null,
	   "utter_action": "utter_None",
	   "intent_response_key": null
	  },
	 "ranking": []
    },
    "all_retrieval_intents": []
   }
  },
  "message_id": "f57ad5efaabc49e9b80a5ad5d1c54e40",
  "text": "I'm at the Columbus office.",
  "event": "user",
  "timestamp": 1719943437.68959
 },
 {
  "metadata": {
   "model_id": "e3446bf187254f30b008e14cd2c003fa"
  },
  "name": "yesOrno",
  "event": "slot",
  "value": "I'm at the Columbus office.",
  "timestamp": 1719943437.6898
 },
 {
  "metadata": {
   "model_id": "e3446bf187254f30b008e14cd2c003fa"
  },
  "use_text_for_featurization": false,
  "event": "user_featurization",
  "timestamp": 1719943437.73715
 },
 {
  "metadata": {
   "model_id": "e3446bf187254f30b008e14cd2c003fa"
  },
  "action_text": null,
  "hide_rule_turn": false,
  "confidence": 1,
  "name": "action_eyJ0aWQiOjI3NDIwLCJ0eXBlIjoiYXNrX2FmZmlybWF0aW9uIn0=",
  "event": "action",
  "type": "ask_affirmation",
  "timestamp": 1719943437.73716,
  "policy": "AugmentedMemoizationPolicy"
 },
 {
  "metadata": {
   "model_id": "e3446bf187254f30b008e14cd2c003fa"
  },
  "data": {
   "custom": {
	 "payload": {
      "quick_replies": [
	   {
	    "payload": "/relief",
	    "title": "Yes"
	   },
	   {
	    "payload": "/advanced_nlu_fallback",
	    "title": "No"
	   }
	  ],
	  "text": "I am not quite sure what you are saying. Are you talking about relief?"
	 },
	"script_typing": 0,
	"msgid": "5bb71974-522f-4e3c-80a5-ebf9e23f6fbf",
	"fallback_text": ""
   }
  },
  "text": null,
  "event": "bot",
  "timestamp": 1719943437.73722
 },
 {
  "metadata": {
  "model_id": "e3446bf187254f30b008e14cd2c003fa"
 },
 "action_text": null,
 "hide_rule_turn": false,
 "confidence": 1,
 "name": "action_listen",
 "event": "action",
 "type": "listen",
 "timestamp": 1719943437.74102,
 "policy": "AugmentedMemoizationPolicy"
},
{
 "metadata": {
  "model_id": "e3446bf187254f30b008e14cd2c003fa"
 },
 "name": "last customer message",
 "event": "slot",
 "value": "I'm in the New York office.",
 "timestamp": 1719943447
},
{
 "input_channel": "rest",
 "metadata": {
  "model_id": "e3446bf187254f30b008e14cd2c003fa"
 },
 "parse_data": {
  "metadata": [],
  "entities": [],
  "intent_ranking": [
   {
    "confidence": 0.99,
    "name": "nlu_fallback"
   },
   {
    "confidence": 0.432721138000488,
	"name": "relief"
   },
  {
   "confidence": 0.401632755994797,
   "name": "account_trouble"
  },
  {
   "confidence": 0.061856634914875,
   "name": "thanks"
  },
  {
   "confidence": 0.0409050695598125,
   "name": "Password_reset"
  },
  {
   "confidence": 0.0317919477820396,
   "name": "agree"
  },
  {
   "confidence": 0.0194509346038103,
   "name": "disagree"
  },
  {
   "confidence": 0.00719568505883217,
   "name": "greetings"
  },
  {
   "confidence": 0.00444584107026458,
   "name": "goodbyes"
  }
],
"message_id": "ceff2630054d4fe4adc9cb147150d5e6",
"text": "I'm in the New York office.",
 "text_tokens": [
  [0, 1],
  [2, 3],
  [4, 6],
  [7, 10],
  [11, 14],
  [15, 19],
  [20, 26]
 ],
 "intent": {
  "confidence": 0.99,
  "name": "nlu_fallback"
 },
 "response_selector": {
  "default": {
   "response": {
    "confidence": 0,
    "responses": null,
    "utter_action": "utter_None",
    "intent_response_key": null
   },
   "ranking": []
  },
  "all_retrieval_intents": []
 }
},
"message_id": "ceff2630054d4fe4adc9cb147150d5e6",
"text": "I'm in the New York office.",
"event": "user",
"timestamp": 1719943447.09339
},
{
 "metadata": {
  "model_id": "e3446bf187254f30b008e14cd2c003fa"
 },
 "name": "yesOrno",
 "event": "slot",
 "value": "I'm in the New York office.",
 "timestamp": 1719943447.0936
},
{
 "metadata": {
  "model_id": "e3446bf187254f30b008e14cd2c003fa"
 },
 "use_text_for_featurization": false,
 "event": "user_featurization",
 "timestamp": 1719943447.15005
},
{
 "metadata": {
  "model_id": "e3446bf187254f30b008e14cd2c003fa"
 },
 "action_text": null,
 "hide_rule_turn": false,
 "confidence": 1,
 "name": "action_eyJ0aWQiOjI3NDIwLCJ0eXBlIjoiYXNrX2FmZmlybWF0aW9uIn0=",
 "event": "action",
 "type": "ask_affirmation",
 "timestamp": 1719943447.15007,
 "policy": "AugmentedMemoizationPolicy"
},
{
 "metadata": {
  "model_id": "e3446bf187254f30b008e14cd2c003fa"
 },
"data": {
 "custom": {
  "payload": {
   "quick_replies": [
    {
     "payload": "/relief",
	 "title": "Yes"
	},
	{
	 "payload": "/advanced_nlu_fallback",
	 "title": "No"
	}
   ],
   "text": "I am not quite sure what you are saying. Are you talking about relief?"
  },
  "script_typing": 0,
  "msgid": "37a3b57b-7e88-4627-ac58-4d957efcca96",
  "fallback_text": ""
 }
},
"text": null,
"event": "bot",
"timestamp": 1719943447.15014
},
{
 "metadata": {
  "model_id": "e3446bf187254f30b008e14cd2c003fa"
 },
 "action_text": null,
 "hide_rule_turn": false,
 "confidence": 1,
 "name": "action_listen",
 "event": "action",
 "type": "listen",
 "timestamp": 1719943447.15575,
 "policy": "AugmentedMemoizationPolicy"
},
{
 "metadata": {
  "model_id": "e3446bf187254f30b008e14cd2c003fa"
 },
 "name": "last customer message",
 "event": "slot",
 "value": "I report to the NYC office",
 "timestamp": 1719944386
},
{
 "input_channel": "rest",
 "metadata": {
  "model_id": "e3446bf187254f30b008e14cd2c003fa"
 },
 "parse_data": {
  "metadata": [],
  "entities": [],
  "intent_ranking": [
   {
    "confidence": 0.99,
    "name": "nlu_fallback"
   },
   {
    "confidence": 0.551150023937225,
    "name": "relief"
   },
   {
    "confidence": 0.177890375256538,
	"name": "account_trouble"
   },
   {
    "confidence": 0.0891190320253372,
    "name": "thanks"
   },
   {
    "confidence": 0.0731835886836052,
    "name": "disagree"
   },
   {
    "confidence": 0.0399214811623097,
    "name": "greetings"
   },
   {
    "confidence": 0.0349704623222351,
    "name": "Password_reset"
   },
   {
    "confidence": 0.0223926920443773,
	"name": "goodbyes"
   },
   {
    "confidence": 0.0113723818212748,
	"name": "agree"
   }
  ],
  "message_id": "77c21edc1bf14f43941af49a62a25d83",
  "text": "I report to the NYC office",
  "text_tokens": [
    [0, 1],
	[2, 8],
	[9, 11],
	[12, 15],
	[16, 19],
	[20, 26]
   ],
   "intent": {
    "confidence": 0.99,
    "name": "nlu_fallback"
   },
   "response_selector": {
     "default": {
      "response": {
	   "confidence": 0,
	   "responses": null,
	   "utter_action": "utter_None",
	   "intent_response_key": null
	  },
	  "ranking": []
	 },
	 "all_retrieval_intents": []
	}
   },
   "message_id": "77c21edc1bf14f43941af49a62a25d83",
   "text": "I report to the NYC office",
   "event": "user",
   "timestamp": 1719944386.09162
  },
  {
   "metadata": {
    "model_id": "e3446bf187254f30b008e14cd2c003fa"
   },
   "name": "yesOrno",
   "event": "slot",
   "value": "I report to the NYC office",
   "timestamp": 1719944386.09182
  },
  {
   "metadata": {
    "model_id": "e3446bf187254f30b008e14cd2c003fa"
   },
   "use_text_for_featurization": false,
   "event": "user_featurization",
   "timestamp": 1719944386.15238
  },
  {
   "metadata": {
    "model_id": "e3446bf187254f30b008e14cd2c003fa"
   },
   "action_text": null,
   "hide_rule_turn": false,
   "confidence": 1,
   "name": "action_eyJ0aWQiOjI3NDIwLCJ0eXBlIjoiYXNrX2FmZmlybWF0aW9uIn0=",
   "event": "action",
   "type": "ask_affirmation",
   "timestamp": 1719944386.1524,
   "policy": "AugmentedMemoizationPolicy"
  },
  {
   "metadata": {
    "model_id": "e3446bf187254f30b008e14cd2c003fa"
   },
   "data": {
    "custom": {
     "payload": {
       "quick_replies": [
        {
         "payload": "/relief",
         "title": "Yes"
        },
        {
         "payload": "/advanced_nlu_fallback",
         "title": "No"
        }
       ],
       "text": "I am not quite sure what you are saying. Are you talking about relief?"
      },
      "script_typing": 0,
      "msgid": "7ca4a2f2-e4c7-45b7-b90c-aee47e818e62",
      "fallback_text": ""
     }
    },
    "text": null,
    "event": "bot",
    "timestamp": 1719944386.15245
   },
   {
    "metadata": {
     "model_id": "e3446bf187254f30b008e14cd2c003fa"
    },
    "action_text": null,
    "hide_rule_turn": false,
    "confidence": 1,
    "name": "action_listen",
    "event": "action",
    "type": "listen",
    "timestamp": 1719944386.15873,
    "policy": "AugmentedMemoizationPolicy"
    }
   ]
  },
  "lastMessageAt": 1719944386159,
  "journey": "start__1-\u003Egreetings__2-\u003Enlu_fallback__3-\u003Eend",
  "transitions": [
   {
    "name": "start__1-\u003Egreetings__2"
   },
   {
    "name": "greetings__2-\u003Enlu_fallback__3"
   },
   {
    "name": "nlu_fallback__3-\u003Eend"
   }
  ]
 }
],
 "per_page": 1,
 "total": 13,
 "count": 1,
 "path": "https://bot-builder-de-na1.niceincontact.com/api/public/conversations",
 "next_page_url": "https://bot-builder-de-na1.niceincontact.com/api/public/conversations?scrollId=FGluY2x1ZGVfY29udGV4dF91dWlk[truncated]",
 "scroll_id": "FGluY2x1ZGVfY29udGV4dF91dWlk[truncated]"
}