Bot Builder Conversations-API
Mit der Conversations-API können Sie Bot Builder-Gesprächsdaten exportieren. Verschiedene Daten werden extrahiert, wie der Name des Kontakts, die Gesprächs-ID, der Kanal Eine Möglichkeit für Kontakte, mit Agenten oder Bots zu interagieren. Kanäle sind zum Beispiel Sprache, E-Mail, Chat, Social Media usw., die Absicht Die Bedeutung oder der Zweck hinter dem, was ein Kontakt sagt/tippt; was der Kontakt mitteilen oder erreichen möchte und der Inhalt der Nachricht. Sie können die exportierten Daten analysieren oder mit anderen Drittanbieterprodukten verarbeiten.
URL
https://bot-builder-de-[region].niceincontact.com/api/public/conversations
Ersetzen Sie [region] in der URL durch die Region, in der Ihr CXone-System ausgeführt wird, wie beispielsweise na1. In der Dokumentation im CXone-Entwicklerportal wird beschrieben, wie Sie Ihre Region ermitteln .
Methode
GET
Autorisierung
Suchen Sie auf der Registerkarte "Präferenzen" > "Importieren und Exportieren" in Bot Builder nach dem Token für den Bot, von dem Sie Gesprächsdaten extrahieren möchten. Das Token befindet sich im Bereich "Gespräche".
Antwort bei Erfolg
Code: 200 OK
Parameter
Schlüssel | Definition |
---|---|
token |
Das von Bot Builder abgerufene Autorisierungs-Token. |
query |
Der Abfragestring zum Filtern von Ergebnissen. Verwenden Sie von Bot Builder unterstützte Abfrageparameter, um Ihre Abfrage zu erstellen. |
perPage |
Die Anzahl der Ergebnisse, die auf jeder Seite angezeigt werden. Der Standardwert ist 50. Der Höchstwert ist 200. Dies ist ein optionaler Parameter. 1719943427.00907 |
timezone |
Die Zeitzone der Zeitstempel in der Antwort ist standardmäßig UTC. Wenn Sie die Zeitstempel in eine andere Zeitzone konvertieren möchten, verwenden Sie diesen Parameter und geben Sie die neue Zeitzone an. Dies ist ein optionaler Parameter. |
Antwort-Header
Schlüssel | Definition |
---|---|
Host | Der Name der Domäne, an die die Anforderung gesendet wurde. |
Date |
Der Zeitpunkt (Datum und Uhrzeit), zu dem die Antwort gesendet wurde. |
Connection | Gibt an, ob die Netzwerkverbindung geöffnet bleibt oder geschlossen wird, wenn die aktuelle Antwort abgeschlossen wird. |
X-Powered-By | Informationen über den Server, wie die verwendete Software. |
Cache-Control | Gibt die Richtlinien für den Browser-Cache in der Anforderung und der Antwort an. |
Content-Type | Der Medientyp der Ressource, die im Antworttext gesendet wird. |
Set-Cookie | Erstellt ein Cookie in dem System, das die Antwort erhält. |
Antwortfelder
Schlüssel | Unterschlüssel | Art | Definition |
---|---|---|---|
data | Array | Einzelheiten finden Sie unter Daten-Array. | |
|
Numerisch | Die Anzahl der Datensätze pro Seite, wie im perPage-Anforderungsparameter angegeben. | |
|
Numerisch | Die Gesamtzahl der Gespräche im Export. | |
|
Numerisch | Die Anzahl der Gespräche auf der aktuellen Seite. | |
path | String | Die URL der aufgerufenen API. | |
next_page_url | String | Die URL zur nächsten Seite mit Daten, sofern vorhanden. | |
scroll_id | String | Die ID zum Abrufen weiterer Ergebnissätze auf Basis einer einzelnen Suchanforderung. |
Daten-Array
Ein Objekt-Array, das Gesprächsdaten enthält.
Schlüssel | Unterschlüssel | Art | Definition |
---|---|---|---|
timestamp | Numerisch | Der Zeitpunkt, zu dem das Gespräch stattgefunden hat. | |
conversationId | String | Die ID des Gesprächs in Bot Builder. | |
customer | Objekt | Enthält Daten über den Kontakt. | |
id | Numerisch? | Die ID des Kontakts in den Bot Builder-Gesprächsdaten. | |
name | String | Der Name des Kontakts. | |
channel | Objekt | Enthält Daten über den Kanal, auf dem das Gespräch stattgefunden hat. | |
id | Numerisch | Die ID des Kanals, auf dem das Gespräch stattgefunden hat. | |
name | String | Der Name des Kanals, auf dem das Gespräch stattgefunden hat. | |
icon | Das Symbol des Kanals, auf dem das Gespräch stattgefunden hat. | ||
isReviewed | Boolescher Wert | Gibt an, ob das Gespräch auf der Registerkarte "Gespräche" in Bot Builder überprüft wurde. | |
dfo | Objekt | Enthält die Fall- und Beitrags-IDs des Gesprächs in Digital Experience. | |
caseId | Numerisch? | Der Fall aus Digital Experience. | |
postId | Numerisch? | Die Beitrags-ID aus Digital Experience. | |
conversationNumber | Numerisch | Die numerische ID, die dem Gespräch auf der Registerkarte "Insights > Gespräche" in Bot Builder zugewiesen wurde. | |
tags | Array | Ein Array mit Tags, die auf das Gespräch angewendet wurden. | |
notes | String | Anmerkungen in Bezug auf das Gespräch. | |
msgCount | Numerisch | Die Anzahl der Nachrichten im Gespräch. | |
tracker | Objekt | Ein Objekt, das Daten über die Ereignisse enthält, die während des Gesprächs aufgetreten sind. Der genaue Inhalt der Ereignisse variiert je nach Gespräch. |
Beispielanforderung
curl --location 'https://chatbot-eu1.brandembassy.com/api/public/conversations?token=YOUR TOKEN HERE&perPage=50'
Beispielantwort
Kopfzeilen
Schlüssel | Beispielwert |
---|---|
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 |
Hauptteil
{
"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]"
}