API de données d'entreprise

Les données métiers 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 conjointement avec l’action MCR META DATA dans Studio. Cette action permet d’envoyer des données d’interaction pour un contact unique au cours des 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 développeur . Connectez-vous avec un compte NiCE CXone, puis vous pourrez effectuer 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 commencer à utiliser les API, vous devez vous enregistrer auprès de NiCE pour recevoir des identifiants valides utilisés pour l'authentification. Consultez la page Prise en main sur le portail des développeurs pour obtenir des instructions.

Utilisation de ces API requiert l’autorisation suivante :

Entité : pour mettre à jour l’API de données d’entreprise, il vous faut l’autorisation Recherche et lecture > API > Mettre à jour les données de l’entreprise.

Mettre à jour les données de l'entreprise

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* :

chaîne de caractères

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 : METTRE

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

Réponse

  • Statut 204 : le serveur a bien traité la demande et il n’y a pas de contenu supplémentaire à envoyer dans le corps de la charge utile de réponse.

  • Statut 400 : la demande contenait des paramètres d’entrée incorrects.

  • Statut 401 : l’authentification a échoué. Les identifiants sont incorrects.

  • Statut 403 : des autorisations sont requises.

  • Statut 404 : le contact demandé est introuvable.

  • État 500 - Erreur de serveur interne.

Mettre à jour les données de l'entreprise

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* :

chaîne de caractères

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

chaîne de caractères

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 : METTRE

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

Réponse

  • Statut 204 : le serveur a bien traité la demande et il n’y a pas de contenu supplémentaire à envoyer dans le corps de la charge utile de réponse.

  • Statut 400 : la demande contenait des paramètres d’entrée incorrects.

  • Statut 401 : l’authentification a échoué. Les identifiants sont incorrects.

  • Statut 403 : des autorisations sont requises.

  • Statut 404 - Le segment demandé est introuvable.

  • État 500 - Erreur de serveur interne.