Business Data API

Bedrijfsgegevens zijn aangepaste gegevensvelden die kunnen worden gekoppeld aan de metadata van een oproep. Met behulp van de Business Data API kunt u de waarden voor de bestaande bedrijfsgegevensvelden bijwerken voor voltooide interacties. U kunt geen nieuwe bedrijfsgegevensvelden toevoegen met deze API. Deze API werkt samen met de MCR META DATA -actie in Studio. Met deze actie kunt u interactiegegevens verzenden voor één contact tijdens live interacties.

Documentatie voor de Business Data API is beschikbaar in de Developer Community portal .

Voordat u begint

U kunt CXone Mpower API's testen op de ontwikkelaarsportal . Meld u aan met een CXone Mpower-account, dan kunt u verzoeken doen met de tenantGesloten Een organisatorische eenheid op hoog niveau die wordt gebruikt om technische ondersteuning, facturering en globale instellingen voor uw CXone Mpower-systeem te beheren. van uw account.

Om de API's te kunnen gebruiken, moet u zich registreren bij NiCE. U ontvangt dan geldige inloggegevens die u voor authenticatie kunt gebruiken. Raadpleeg de pagina Aan de slag op de ontwikkelaarsportal voor instructies.

Gebruik van deze API's vereist de volgende toestemming:

Entiteit: om de Business Data API bij te werken, dient u over de machtiging Zoeken & afspelen > API's > Bedrijfsgegevens bijwerken te beschikken.

Bedrijfsgegevens bijwerken

Voor een gesloten interactie werkt u de bestaande bedrijfsgegevensveldinformatie bij voor alle segmenten die beschikbaar zijn voor de opgegeven ACD contactId.

Methode: ZETTEN

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

Parameters:

contact-ID*:

string

Unieke identificatie van de ACD contactId waarvoor de bedrijfsgegevenswaarden moeten worden bijgewerkt.

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

Type: PUT

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

Respons

  • Status 204 - De server heeft succesvol aan het verzoek voldaan en er is geen aanvullende inhoud om te verzenden in de payloadinhoud van de respons.

  • Status 400 -Het verzoek bevatte onjuiste invoerparameters.

  • Status 401 - Authenticatie mislukt. Onjuiste inloggegevens.

  • Status 403 - Machtigingen vereist.

  • Status 404 - Aangevraagd contact niet gevonden.

  • Status 500 - Interne serverfout.

Bedrijfsgegevens bijwerken

Voor een gesloten interactie werkt u de bestaande bedrijfsgegevensveldinformatie bij voor het opgegeven segment in de opgegeven ACD contactId.

Methode: ZETTEN

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

Parameters:

contact-ID*:

string

Unieke identificatie van de ACD contactId die het segment bevat met de bedrijfsgegevenswaarden die moeten worden bijgewerkt.
segment-ID*:

string

Unieke identificatie van het ACD contactId-segment met de bedrijfsgegevenswaarden die moeten worden bijgewerkt.

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

Type: PUT

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

Respons

  • Status 204 - De server heeft succesvol aan het verzoek voldaan en er is geen aanvullende inhoud om te verzenden in de payloadinhoud van de respons.

  • Status 400 -Het verzoek bevatte onjuiste invoerparameters.

  • Status 401 - Authenticatie mislukt. Onjuiste inloggegevens.

  • Status 403 - Machtigingen vereist.

  • Status 404 - Het gevraagde segment is niet gevonden.

  • Status 500 - Interne serverfout.