API de données d’entreprise

Les données d’entreprise sont des champs personnalisés qui peuvent être associés aux métadonnées de l’appel. À l’aide de l’API de données d’entreprise, vous pouvez mettre à jour les valeurs des champs de données d’entreprise existants pour toutes les interactions fermées. Vous ne pouvez pas ajouter de nouveaux champs de données d’entreprise à l’aide de cette API. Cette API fonctionne parallèlement à l’action MCR META DATA dans Studio. Cette action vous permet d’envoyer des données d’interaction pour un seul contact pendant les interactions en direct.

La documentation de l’API Business Data est disponible sur le portail de la communauté des développeurs .

Avant de commencer

Vous pouvez tester les API NiCE CXone sur le portail des développeurs . Connectez-vous avec un compte NiCE CXone, puis vous pourrez faire des demandes avec le locataireClosed Regroupement organisationnel de haut niveau utilisé pour gérer le soutien technique, la facturation et les paramètres globaux de votre système NiCE CXone. de votre compte.

Pour démarrer l'utilisation des API, vous devez vous enregistrer auprès de NiCE afin de recevoir des identifiants valides utilisés pour l'authentification. Revoyez la Page Démarrage sur le portail des développeurs pour connaître les instructions.

L’utilisation de ces API nécessite l’autorisation suivante :

Entité : Pour mettre à jour l’API Données commerciales, vous devez disposer de l’autorisation Recherche et lecture > API > Mettre à jour les données commerciales.

Mettre à jour les données commerciales

Pour une interaction fermée, mettez à jour les informations du champ de données commerciales existant pour tous les segments disponibles pour le ACD contactId donné.

Méthode : PUT

Point de terminaison : /business-data-manager/v1/business-data/contact/{ACD contactId}

Paramètres :

contactId* :

string

Identifiant unique du ACD contactId pour lequel mettre à jour les valeurs des données commerciales.

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

Tapez : PUT

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

Réponse

  • État 204 - Le serveur a répondu avec succès à la demande et il n’y a pas de contenu supplémentaire à envoyer dans le corps de la réponse.

  • État 400 - La demande contient des paramètres de saisie incorrects.

  • État 401 - Échec de l’authentification. Informations d’identification incorrectes.

  • État 403 - Autorisations requises.

  • État 404 - Le contact demandé est introuvable.

  • État 500 - Erreur de serveur interne.

Mettre à jour les données commerciales

Pour une interaction fermée, mettez à jour les informations du champ de données commerciales existant pour le segment spécifié dans le ACD contactId donné.

Méthode : PUT

Point de terminaison : /business-data-manager/v1/business-data/contact/{ACD contactId}/segment/{segmentId}

Paramètres :

contactId* :

string

Identifiant unique du ACD contactId qui contient le segment avec les valeurs des données commerciales à mettre à jour.
segmentId*:

string

Identifiant unique du segment ACD contactId avec les valeurs de données commerciales à mettre à jour.

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

Tapez : PUT

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

Réponse

  • État 204 - Le serveur a répondu avec succès à la demande et il n’y a pas de contenu supplémentaire à envoyer dans le corps de la réponse.

  • État 400 - La demande contient des paramètres de saisie incorrects.

  • État 401 - Échec de l’authentification. Informations d’identification incorrectes.

  • État 403 - Autorisations requises.

  • Statut 404 - Le segment demandé est introuvable.

  • État 500 - Erreur de serveur interne.