API y Scripts

La información de esta página de ayuda 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

La REST API Studio acción le permite realizar Llamadas a la API Sosegado 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 debe utilizar 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 usar en la plataforma. También le permite almacenar datos confidenciales, como contraseñas o claves, en un formato cifrado para usar en los scripts.

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

Integration Hub es la otra opción que debe utilizar si sus llamadas incluyen JSON.
NiCE CXone API Studio acciones Studio tiene numerosas acciones de API que le permiten realizar llamadas a las API de NiCE CXone desde sus scripts. No todas las API de NiCE CXone están disponibles como una acción, pero cuando una está disponible, debe utilizarla en lugar de otro método. Puede encontrar las acciones de API en la sección de API de la pestaña Framework en Desktop Studio y la paleta de Acciones de API en Studio.
acción de SNIPPET

Puede escribir código en una acción SNIPPET para conectarse a servicios web Sosegado 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 causar problemas graves de rendimiento en la plataforma. Sin embargo, debe utilizar este método si:

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

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

Integraciones del flujo de trabajo del CRM Configure las integraciones de flujo de trabajo de CRMClosed sistemas de Terceros que administran cosas como contactos, información de ventas, detalles de soporte e historiales de casos. cuando necesite realizar llamadas de API al CRM de su organización. Esto es compatible en 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 y las interrupciones del clúster. Esto es estrictamente obligatorio.

Este límite se aplica a cualquier método de conexión a servicios web, incluida la API REST acción, Integration Hub, y realizar llamadas con la acción SNIPPET. Si puede, use la acción API REST en lugar de la acción SNIPPET para sus API REST. API REST tiene un límite de devolución 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:

  • Filter the data in the API response: For example, if you're using the NiCE reporting API to get contacts, you can filter the results by the startDate and endDate of the contact. This API call also allows you to return and limit a top count of items. Refer to the API documentation that came with your script integration to determine what filtering you can use.

  • Update the API request to return only the data you need: For example, if you're using the NiCE reporting API to get contacts, you can use the contactId or agentId fields to return only relevant data. Refer to the API documentation that came with your script integration to determine what data limits you can use.

  • Build middleware: If you cannot do either of the previous options, build middleware that does filtering based on custom criteria you define. If you do this, ensure that your middleware does not add latency to the call.

 

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 pasar al script.

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

  • Se canceló la solicitud: la operación agotó el tiempo límite. Es posible que la solicitud se haya procesado o no. La validación debe ocurrir 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 utilizando la propiedad ProxyTimeoutSeconds.

  • Primitivo JSON no válido. El analizador JSON se confundió con la respuesta. Es posible que la respuesta haya incluido caracteres no válidos o que no fuera JSON. A menudo, este error ocurre cuando la respuesta se envía en HTML. Puede probar la respuesta en el depurador de snippets. El artículo de la base de conocimiento A square with an arrow pointing from the center to the upper right corner. La Respuesta de la API REST no es JSON ni XML válido puede ayudar.

  • Los datos a nivel raíz no son válidos. El analizador XML se confundió con la respuesta. Es posible que la respuesta haya incluido caracteres no válidos o que no fuera XML. A menudo, este error ocurre cuando la respuesta se envía en HTML. El artículo de la base de conocimientoA square with an arrow pointing from the center to the upper right corner. La Respuesta de la API REST no es JSON ni XML válido puede ayudar.

  • 'doctype' es un token inesperado. 'DOCTYPE’ es un token esperado. Ver Datos a nivel raíz es inválido 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 en esta lista Datos a nivel raíz es inválido.

  • Se cerró la conexión subyacente: se produjo un error inesperado en un envío. A menudo esto significa que hay un problema con el protocolo de enlace (handshake) de TLS. También puede deberse a que una IP o un puerto no están abiertos en un firewall; al uso de una versión antigua y no compatible de TLS; a certificados no válidos o caducados; al uso de una Dirección ip en combinación con HTTPS; o a problemas similares. Resuelva este problema con los registros del firewall 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 produjo un error inesperado 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 produjo un error inesperado en un envío en esta lista.

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