API y Scripts

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

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

Opciones admitidas

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

Opción Detalles
REST API Studio acción

The REST API Studio acción le permite realizar llamadas de REST API desde sus Scripts. Este método:

  • Puede manejar cargas más altas en comparación con realizar llamadas Sosegado en una SNIPPET acción, particularmente a gran escala.
  • Es el método preferido de hacer llamadas API en los scripts.
  • Es una de las opciones que se deben usar si sus llamadas incluyen JSON.

Integration Hub

Integration Hub es una aplicación de NiCE CXone que le permite configurar la autenticación y las solicitudes de API para usarlas en la plataforma. También le permite almacenar datos confidenciales, como contraseñas o claves, en un formato cifrado para usarlos en Scripts.

La acción CONNECTREQUEST action y la acción CONNECTAUTH action le permiten usar los detalles de autenticación configurados y las solicitudes en sus Scripts.

Integration Hub es la otra opción que se debe usar si sus llamadas incluyen JSON.
NiCE CXone API Studio acciones Studio tiene numerosos acciones de API que le permiten realizar llamadas a las API de NiCE CXone desde sus Scripts. No todas las API NiCE 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 Studio.
Acciones de SNIPPET

Puede escribir código en una acción SNIPPET para conectarse a servicios web RESTful o SOAP desde su script. Este no es el método recomendado para realizar llamadas REST, ya que puede ralentizar el manejo de contactos y provocar graves problemas de rendimiento en la plataforma. Sin embargo, debe usar este método si:

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

Si debe usar SNIPPET, revise las recomendaciones para minimizar el impacto en su sistema antes de conectarse a servicios web RESTful o SOAP.

Integraciones del flujo de trabajo de CRM Configurar integraciones de flujo de trabajo CRMClosed Third-party systems that manage such things as contacts, sales information, support details, and case histories. cuando necesita hacer llamadas API para el CRM de su organización. This is supported in Agent Workspace (Agent), Agent Workspace (Embedded) (Agent Embedded), y Agent Workspace (Browser Extension) (Agent Integrated).

Limitaciones en el tamaño de los datos devueltos

La plataforma NiCE CXone 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 se aplica a cualquier método de conexión a servicios web, incluyendo la acción REST API, Integration Hub y la realización de llamadas con la acción SNIPPET. Si puede hacerlo, use la acción REST API en lugar de la acción SNIPPET para sus REST API. REST API tiene un límite de retorno de 32 KB, pero puede manejar una carga más pesada que la que puede manejar el método SNIPPET.

Para reducir el tamaño de los datos devueltos:

  • Filtrar los datos en la respuesta de la API: Por ejemplo, si utiliza la API de generación de reportes de NiCE para obtener contactos, puede filtrar los resultados por el startDate y el endDate del contacto. Esta Llamada a la API también le permite devolver y limitar una cantidad de los mejores elementos. Consulte la documentación de la API que vino con su integración de script para determinar qué filtro puede usar.

  • Actualice la solicitud de API para que devuelva solo los datos que necesita: por ejemplo, si está utilizando la API de Reporting NiCE para obtener contactos, puede usar los campos contactId o agentId para devolver solo los datos importantes. Consulte la documentación de la API que vino con su integración de script para determinar qué límites de datos puede usar.

  • Compilar middleware: Si no puede realizar ninguna de las DOs opciones anteriores, compile middleware que realice el filtro según criterios personalizados que usted defina. Si lo hace, asegúrese de que su middleware no agregue latencia a la llamada.

 

Código de Error -1

El código de error -1 es un código interno utilizado para identificar que se ha encontrado un error con una Llamada a la API. Específicamente, este código indica que se trata de una situación en la que no se devolverá un código de estado HTTP, o en la que se devuelve pero no se puede transmitir al script.

La descripción del estado que acompaña al código de Error -1 puede ayudarle a determinar la incidencia. Las descripciones del estado que pueden acompañar a este código incluyen:

  • Se interrumpió la solicitud: la operación agotó el tiempo límite. Es posible que la solicitud se haya procesado o no. Se debe realizar una validación antes de configurar un bucle en respuesta a un código de estado -1. Es posible que deba cambiar la configuración de tiempo límite en la llamada mediante la propiedad ProxyTimeoutSeconds.

  • Primitivo JSON no válido. El analizador JSON se confundió con la respuesta. La respuesta pudo 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 la depurador de Snippet. La Respuesta de REST API no es un JSON ni XML válido A square with an arrow pointing from the center to the upper right corner. de la base de conocimiento puede ser de ayuda.

  • Data at the root level is invalid. The XML parser was confused by the response. The response may have included invalid characters or wasn't XML. Often, this error occurs when the response is sent in HTML. The REST API Response is not valid JSON or XML  A square with an arrow pointing from the center to the upper right corner. knowledge base article may help.

  • «doctype» es un token inesperado. 'DOCTYPE’ es un token esperado. Consulte Los datos en el nivel raíz no SOn válidos en esta lista.

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

  • The underlying connection was closed: An unexpected error occurred on a send. Often this means that there is a problem with the TLS handshake. It can also be caused by an IP or port not being open on a firewall; using an old, unsupported version of TLS; invalid or expired certificates; using an IP address in combination with HTTPS; or similar issues. Troubleshoot this response with the firewall logs on the receiving server side.

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

  • Se canceló la solicitud: No pudo crear un canal seguro SSL/TLS. Consulte La conexión subyacente se cerró: Se produjo un error inesperado en un envío en esta lista.

  • Response too large. (> 32 KB). The response contains more than 32 KB of data. When this happens, the response is discarded because the system has no way of storing more than 32 KB in one variable. The response must be modified or filtered to reduce the amount of data returned.