Scripts et API

Les informations sur cette page d’aide concernent à la fois CXone Studio et Desktop Studio.

Vous pouvez établir une connexion à des services web avec des scripts Studio qui suivent les normes d’API SOAP ou RESTful. Vous pouvez utiliser les méthodes suivantes :

  • Action Studio REST API
  • Integration Hub
  • Actions Studio d’API
  • Intégrations de flux de travail CRM

 

Services Web RESTful

Vous pouvez utiliser des scripts Studio pour vous connecter aux API RESTful à l’aide du proxy REST dans une action Snippet. Vous pouvez accéder à ce service à l'aide de la fonction GetRestProxy(). Le proxy REST permet à vos scripts d'interagir avec des serveurs Web distants. Il fournit des propriétés et des fonctions que vous pouvez utiliser à cette fin.

Le proxy REST nécessite l'utilisation d’objets de données dynamiques. Le type de données dynamiques permet à vos scripts de travailler avec des réponses formatées en XML et JSON. Les objets de données dynamiques peuvent recevoir des données dans ces formats et permettre leur lecture. Vous pouvez également créer de manière dynamique des objets pouvant être convertis en XML ou en JSON. Ces capacités sont nécessaires pour utiliser les API RESTful.

Pour utiliser le proxy REST, ajoutez une action Snippet à votre script et ouvrez la fenêtre Snippet Editor . Appelez la fonction GetRESTProxy() en utilisant la syntaxe suivante.

ASSIGN proxy = GetRESTProxy() 
 proxy.<property | function>([parameters]) 

Pour <property | function>, choisissez parmi les propriétés et les fonctions décrites dans les sections suivantes.

Propriétés

Propriété Détails
StatusCode Contient le code d'état HTTP suite à un appel à MakeRestRequest(). Cette propriété ne peut pas être modifiée. Si la fonction échoue, elle ne contient plus le code d’état.
StatusDescription Contient la description d’état HTTP suite à un appel à MakeRestRequest(). Cette propriété ne peut pas être modifiée.
ContentType

Permet de remplacer l’en-tête content-type par défaut. La valeur par défaut est application/x-www-form-urlencoded.

En fonction de l'appel que vous effectuez, il se peut que vous deviez modifier l'en-tête. Par exemple, si vous envoyez du JSON, vous devrez le remplacer par application/json. Vous devez modifier cette propriété.

ProxyTimeoutSeconds Permet de modifier le délai d'attente de la demande. La valeur par défaut est de 10 secondes. Vous devez modifier cette propriété.

Fonctions

Le tableau suivant fournit des informations sur les fonctions disponibles pour la connexion aux API RESTful. Il existe des fonctions proxy REST supplémentaires qui vous permettent de coder et de hacher des chaînes.

Fonction Détails
MakeRestRequest(URL) Effectue une requête HTTP vers l'URL désignée.
AddHeader Ajoute un en-tête personnalisé à la requête HTTP.
ClearHeaders Efface tous les en-têtes personnalisés ajoutés avec AddHeader.

Exemples

ASSIGN proxy = GetRESTProxy()
ASSIGN proxy.ContentType = "application/json"
ASSIGN url = "https://catfact.ninja/fact"
ASSIGN verb = "GET"
ASSIGN result = proxy.MakeRestRequest(url,payload,'JSON',verb)

 

ASSIGN restProxy=GetRESTProxy()

restProxy.AddHeader("x-api-key", "qwer") //Assigning incorrect header for demonstration purposes
restProxy.ClearHeaders()
restProxy.AddHeader("x-api-key", "asdf")
ASSIGN restProxy.ProxyTimeoutSeconds = "2"
ASSIGN restProxy.ContentType = "application/json"

ASSIGN uri = "http://postman-echo.com/post"

DYNAMIC beowulfCharacteristics
ASSIGN beowulfCharacteristics.name = "Beowulf"
ASSIGN beowulfCharacteristics.occupation= "Hero" 
ASSIGN beowulfCharacteristics.foe = "Grendel"
ASSIGN payloadJSON = "{beowulfCharacteristics.asJSON()}

Services Web SOAP

Vous pouvez utiliser des services web basés sur SOAP avec des scripts Studio. Pour ce faire, vous devez importer un WSDL ou une DLL proxy dans Studio. La DLL importée doit être autorisée par NICE CXone. Après avoir autorisé la DLL, celle-ci est enregistrée à la racine du stockage de fichiers de votre locataireFermé Regroupement organisationnel de haut niveau utilisé pour gérer le support technique, la facturation et les paramètres globaux de votre CXone environnement.

L'utilisation des services web SOAP nécessite l'assistance de NICE CXone. Contactez votreReprésentant de compte CXone pour plus d'informations.

Utilisation de SOAP dans un snippet

Lorsque vous voulez utiliser un service Web basé sur SOAP dans un script Studio, vous devez créer un snippet. Ajoutez une action Snippet au script. Dans la fenêtre Éditeur de snippets, ajoutez une déclaration USES qui nomme le fichier DLL proxy que vous avez généré et stocké dans le stockage de fichiers de votre locataireFermé Regroupement organisationnel de haut niveau utilisé pour gérer le support technique, la facturation et les paramètres globaux de votre CXone environnement.

Le snippet suivant est un exemple d'utilisation d'un service Web basé sur SOAP avec un script Studio.

USES "sf.dll"
cStart="{now}"
sforce=new SforceService()
session=new SessionHeader()
loginResult=sforce.login("demo@nice.com",password6")
sforce.sessionheadervalue=session
session.sessionid=loginResult.sessionid
sforce.url=loginresult.serverUrl

t=new Task()
t.ActivityDate=#"8/20/2050"
t.Description="Call placed by {first }{Last}."
t.Subject="Call @{cStart}"
t.Status="Completed"
t.CallType="Outbound"
t.OwnerId=SF_Agent_ID
t.ReminderDateTime="{cStart}"

SWITCH Type
{
   CASE "CON" { t.WhoId=SF_Obj_ID }
   CASE "LEA" { t.WhoId=SF_Obj_ID }
   CASE "ACC" { t.WhatId=SF_Obj_ID }
   CASE "OPP" { t.WhatId=SF_Obj_ID }
   CASE "CAS" { t.WhatId=SF_Obj_ID }
}
SaveResult=sforce.create(t)