API y Scripts

En sus scripts Studio, puede conectarse a los servicios web que usan los estándares de las API SOAP o RESTful.

Opciones soportadas

Studio soporta las siguientes maneras de conectarse a los servicios web:

Opción Detalles
REST API Studio acción

La REST API Studio acción le permite hacer llamadas de la API RESTful desde sus scripts. Este método:

  • Puede manejar cargas mayores que hacer llamadas RESTful en una acción SNIPPET, en particular a escala.
  • Es el método preferido de hacer llamadas API en los scripts.
  • Es la opción a usar si sus llamadas incluyen JSON.
AccionesCXone API Studio Studio tiene varias acciones API  que le permiten hacer llamadas a las API CXone desde sus scripts. No todas las API CXone están disponibles en una acción, pero cuando está disponible una, debe usarla en vez de otro método. Puede encontrar las acciones API en la sección API de la pestaña Marco en Desktop Studio y la paleta de Acciones API en CXone Studio.
Acción de SNIPPET

Puede escribir código en una SNIPPET acción para conectarse a los servicios web RESTful o SOAP desde su script. Este no es el método recomendado para hacer llamadas REST porque puede alentar el manejo de contactos. Sin embargo, debe usar este método si:

  • Sus llamadas incluyen XML.
  • Se está conectando a un servicio SOAP.

Limitaciones sobre el Tamaño de Datos Devueltos

La CXone Plataforma permite que las API REST devuelvan hasta 32 KB de datos. Este límite evita la inestabilidad del clúster y las interrupciones. Esto es estrictamente obligatorio.

Este límite aplica a cualquier método de conectar servicios web, que incluye la REST API acción y hacer llamdas con la acción SNIPPET. Si puede, utilice la acción REST API en lugar de la acción SNIPPET para sus API REST. REST API tiene un límite de devolución de 32 KB, pero puede manipular una carga mayor que lo que puede el método SNIPPET.

Para reducir el tamaño de los datos devueltos:

  • Filtre los datos en la respuesta de la API. Por ejemplo, si utiliza la API de generación de informes NICE para obtener contactos, puede filtrar los resultados por startDate y endDate el contacto. Esta llamada a la API también permite devolver y limitar el recuento máximo de elementos. Consulte la documentación para su API a la que está llamando que determine que filtro puede usar.
  • Actualice la solicitud API para que devuelva sólo los datos que necesita. Por ejemplo, si está utilizando la API de generación de informes NICE para obtener contactos, puede utilizar los campos contactIdo agentId para devolver únicamente los datos relevantes. Consulte la documentación para su API a la que está llamando que determine qué límites de datos pueden usar.

Si no puede utilizar ninguna de las opciones anteriores, cree un middleware.

Código de Error -1

El código de error -1 es un código interno que se usa para identificar que se ha encontrado un error con una llamada API. En específico, este código indica que es una situación donde se devolverá un código de estatus HTTP, o donde se devuelve pero no se puede transferir al script.

La descripción del estatus que acompaña el código de error -1 puede ayudar a determinar el problema. Las descripciones de estatus que pueden acompañar este código incluyen:

  • Se abandonó la solicitud: Le terminó el tiempo de la operación. Puede o no haberse procesado la solicitud. Debiera ocurrir la validación antes de configurar un ciclo de respuesta a un código de estatus -1. Puede necesitar cambiar la configuración del tiempo de vencimiento en la llamada usando la propiedad ProxyTimeoutSeconds.

  • JSON Primitivo inválido. Se confundió el analizador JSON con la respuesta. La respuesta puede haber incluido caracteres no válidos o no era JSON. A menudo, se presenta este error cuando la respuesta se envía en HTML. Puede probar la respuesta en el depurador de snippets. La Respuesta API REST API no es un JSON o XML válido Un cuadrado con una flecha que apunta desde el centro hacia la esquina superior derecha. puede ayudar el artículo de la base de conocimientos.

  • No son válidos los datos a nivel raíz. Se confundió el analizador XML con la respuesta. La respuesta puede haber incluido caracteres no válidos o no era XML. A menudo, se presenta este error cuando la respuesta se envía en HTML. La Respuesta API REST API no es un JSON o XML válido Un cuadrado con una flecha que apunta desde el centro hacia la esquina superior derecha. puede ayudar el artículo de la base de conocimientos.

  • ‘doctype’ es un token no esperado. 'DOCTYPE’ es un token esperado. Ver en esta lista Datos a nivel raíz es inválido.

  • La etiqueta de inicio 'br’ en la línea x posición x no coincide con la etiqueta al final de 'body'. Ver en esta lista Datos a nivel raíz es inválido.

  • Se cerró la conexión subyacente: Se presentó un error no esperado en un envío. Normalmente esto significa que hay un problema con el intercambio TSL. También se puede causar porque una IP o puerto no se abra en un cortafuegos; usar una versión anterior, no soportada de TLS; certificados inválidos o vencidos; usar una dirección IP junto con HTTPS; o problemas similares. Resolver los problemas de esta respuesta con el cortafuegos se registra en el lado del servidor receptor.

  • Se cerró la conexión subyacente: No se puedo establecer una relación de confianza para el canal de seguridad SSL/TLS. Ver Se cerró la conexión subyacente: Se presentó un error no esperado en un envío en esta lista.

  • Se canceló la solicitud: No pudo crear un canal seguro SSL/TLS. Ver Se cerró la conexión subyacente: Se presentó un error no esperado en un envío en esta lista.

  • Respuesta muy grande. (> 32 KB). La respuesta contiene más de 32 KB de datos. Cuando esto sucede, se descarta la respuesta porque el sistema no tiene manera de almacenar más de 32 KB en una variable. Debe modificarse o filtrarse la respuesta para reducir la cantidad de datos devueltos.