Scripts y APIs

La información de esta página de ayuda aplica tanto a CXone Studio como a Desktop Studio.

Se puede conectar a los servicios web con los scripts Studio que utilizan los estándares de las API SOAP o RESTful. Se puede conectar con los siguientes métodos:

  • Acción API Studio REST
  • Integration Hub
  • Acciones API Studio
  • Integraciones del flujo de trabajo del CRM

 

Servicios Web RESTful

Puede utilizar los scripts Studio para conectarse con las API RESTful mediante el proxy REST en una acción Snippet. Puede ingresar a este servicio con la función GetRestProxy(). El proxy REST permite que sus scripts interactúen con servidores web remotos. Ofrece algunas propiedades y funciones que usted puede utilizar para esto.

El proxy REST requiere el uso de objetos de datos dinámicos. El tipo de datos dinámico permite que sus scripts funcionen con respuestas con formato en XML y JSON. Los objetos de datos dinámicos pueden recibir datos en estos formatos y permitir su lectura. También puede crear objetos dinámicamente que se pueden convertir a XML o JSON. Estas habilidades son necesarias para utilizar las API RESTful.

Para usar el proxy REST, agregar una acción Snippet a su script y abrir la ventana Snippet Editor . Llamar a la función GetRESTProxy() usando la siguiente sintaxis.

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

Para <property | function>, elija entre las propiedades y funciones que se describen en las siguientes secciones.

Propiedades

Propiedad Detalles
StatusCode Contiene el código de estado HTTP después de una llamada a MakeRestRequest(). No se puede modificar esta propiedad. Si falla la función, ya no mantiene el código de estado.
StatusDescription Mantiene la descripción del estado HTTP después de una llamada a MakeRestRequest(). No se puede modificar esta propiedad.
ContentType

Le permite anular el encabezado de tipo de contenido predeterminado. El valor predeterminado es application/x-www-form-urlencoded:

Dependiendo de la llamada que esté realizando, es posible que tenga que cambiar el encabezado. Por ejemplo, si envía JSON, cambie esto a application/json. Debe modificar esta propiedad.

ProxyTimeoutSeconds Le permite cambiar el tiempo de espera de la solicitud. El valor predeterminado es 10 segundos. debe modificar esta propiedad.

Funciones

La siguiente tabla proporciona información sobre las funciones disponibles a usar al conectarse a las API RESTful. Hay funciones de proxy REST adicionales que le permiten codificar y hacer un hash con las cadenas.

Función Detalles
MakeRestRequest(URL) Realiza una solicitud HTTP a la URL designada.
AddHeader Agrega un encabezado personalizado a la solicitud HTTP.
ClearHeaders Borra cualquier encabezado personalizado agregado con AddHeader.

Ejemplos

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()}

Servicios Web SOAP

Puede utilizar servicios web basados en SOAP con scripts Studio. Esto requiere que importe un WSDL o DLL proxy a Studio. La DLL importada debe ser autorizada por NICE CXone. Después de autorizar la DLL, se guarda en la raíz del almacenamiento de archivos de su tenant.

El uso de servicios web SOAP requiere la ayuda de NICE CXone. Póngase en contacto con su Representante de cuenta CXone para más información.

Utilice SOAP en un Snippet

Cuando desee utilizar un servicio web basado en SOAP en un script Studio, debe crear un snippet. Agregue una Snippet acción a su script. En la ventana del editor de Snippets, agregue una USES declaración que nombre el archivo DLL proxy que generó y almacenó en el almacenamiento de archivos de su tenant.

El siguiente snippet es un ejemplo del uso de un servicio web basado en SOAP con 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)