Geschäftsdaten-API

Geschäftsdaten sind benutzerdefinierte Felder, die mit den Metadaten des Anrufs verknüpft werden können. Mit der Geschäftsdaten-API können Sie die Werte für die vorhandenen Geschäftsdatenfelder für alle abgeschlossenen Interaktionen aktualisieren. Sie können mit dieser API keine neuen Geschäftsdatenfelder hinzufügen. Diese API funktioniert zusammen mit der MCR META DATA-Aktion in Studio. Mit dieser Aktion können Sie während einer Live-Interaktion Interaktionsdaten für einen einzelnen Kontakt senden.

Die Dokumentation für die Business Data API ist im Developer Community Portal verfügbar.

Bevor Sie beginnen

Sie können CXone Mpower APIs auf dem Entwicklerportal testen. Melden Sie sich mit einem CXone Mpower-Konto an, dann können Sie Anfragen mit dem tenantGeschlossen Eine übergeordnete organisatorische Gruppierung, die Sie für die technische Unterstützung und Abrechnung und außerdem zur Bearbeitung von globalen Einstellungen in Ihrem CXone Mpower-System einsetzen können.. Ihres Kontos stellen.

Um die APIs nutzen zu können, müssen Sie sich bei NiCE registrieren, um gültige Anmeldeinformationen für die Authentifizierung zu erhalten. Anweisungen finden Sie auf der Seite Erste Schritte im Entwicklerportal.

Für die Nutzung dieser APIs ist folgende Berechtigung erforderlich:

Entität: Um die Geschäftsdaten-API zu aktualisieren, benötigen Sie die Berechtigung Suchen & Wiedergabe > APIs > Geschäftsdaten aktualisieren.

Geschäftsdaten aktualisieren

Bei einer abgeschlossenen Interaktion aktualisieren Sie die vorhandenen Geschäftsdatenfeldinformationen für alle Segmente, die für die angegebene ACD contactId verfügbar sind.

Methode: PUT

Endpunkt: /business-data-manager/v1/business-data/contact/{ACD contactId}

Parameter:

contactId*:

String

Eindeutige Kennung der ACD contactId, für die die Geschäftsdatenwerte aktualisiert werden sollen.

URL: https://na1.test.nice-incontact.com/business-data-manager/v1/business-data/contact/8675309

Typ: PUT

[ { "business_data_name1": "string of text" }, { "business_data_name2": true, }, { "business_data_name3": 1234, } ]

Antwort

  • Status 204 – Der Server hat die Anfrage erfolgreich erfüllt und es gibt keine zusätzlichen Inhalte, die im Antwort-Payload-Haupttext gesendet werden müssen.

  • Status 400 – Die Anfrage enthielt falsche Eingabeparameter.

  • Status 401 – Authentifizierungsfehler. Falsche Anmeldedaten.

  • Status 403 – Berechtigungen erforderlich.

  • Status 404 – Angeforderter Kontakt wurde nicht gefunden.

  • Status 500 - Interner Serverfehler.

Geschäftsdaten aktualisieren

Bei einer abgeschlossenen Interaktion aktualisieren Sie die vorhandenen Geschäftsdatenfeldinformationen für das angegebene Segment in der gegebenen ACD contactId.

Methode: PUT

Endpunkt: /business-data-manager/v1/business-data/contact/{ACD contactId}/segment/{segmentId}

Parameter:

contactId*:

String

Eindeutige Kennung der ACD contactId, die das Segment mit den zu aktualisierenden Geschäftsdatenwerten enthält.
segmentId*:

String

Eindeutige Kennung des ACD contactId Segments mit den zu aktualisierenden Geschäftsdatenwerten.

URL: https://na1.test.nice-incontact.com/business-data-manager/v1/business-data/contact/{ACD contactId}/segment/b2e28d4e-ef22-4597-a104-2e740f729686

Typ: PUT

[ { "business_data_name1": "string of text" }, { "business_data_name2": true, }, { "business_data_name3": 8675309, } ]

Antwort

  • Status 204 – Der Server hat die Anfrage erfolgreich erfüllt und es gibt keine zusätzlichen Inhalte, die im Antwort-Payload-Haupttext gesendet werden müssen.

  • Status 400 – Die Anfrage enthielt falsche Eingabeparameter.

  • Status 401 – Authentifizierungsfehler. Falsche Anmeldedaten.

  • Status 403 – Berechtigungen erforderlich.

  • Status 404 – Das angeforderte Segment wurde nicht gefunden.

  • Status 500 - Interner Serverfehler.