API e Scripts

As informações desta página de ajuda se aplicam tanto a Studio quanto a Desktop Studio.

Nos seus scripts Studio, é possível se conectar a serviços web que usam padrões API SOAP ou RESTful.

Opções com suporte

O Studio suporta as seguintes maneiras de conexão a serviços web:

Opção Detalhes
REST API Studio ação

A REST API Studio ação permite que você faça Chamadas de API RESTful a partir de seus scripts. Este método:

  • Pode lidar com cargas mais altas em comparação com fazer chamadas Repousantes em uma ação SNIPPET, particularmente em escala.
  • É o método preferencial para fazer chamadas API em Scripts.
  • É uma das opções a ser usada se suas chamadas incluírem JSON.

Integration Hub

Integration Hub é um aplicativo NiCE CXone que permite configurar autenticação e solicitações de API para usar na plataforma. Ele também permite armazenar dados confidenciais, como senhas ou chaves, em um formato criptografado para usar em scripts.

A ação CONNECTREQUEST action e a ação CONNECTAUTH action permitem que você use os detalhes de autenticação configurados e as solicitações em seus Scripts.

Integration Hub é a outra opção a ser usada se as suas chamadas incluírem JSON.

NiCE CXone API Studio ações Studio tem várias Ações de API que permitem fazer chamadas para as APIs de NiCE CXone a partir de seus scripts. Nem toda NiCE CXone API está disponível como uma ação, mas, quando uma estiver disponível, você deve usá-la em vez de outro método. Você pode encontrar as Ações de API na seção API na guia Estrutura no Desktop Studio e na paleta de Ações de API no Studio.
Ações SNIPPET

Você pode escrever código em uma ação SNIPPET para se conectar a serviços web RESTful ou SOAP a partir do seu script. Esta não é a forma recomendada de fazer chamadas REST porque pode deixar o atendimento de contatos lento e causar problemas graves de desempenho na plataforma. No entanto, você deve usar este método se:

  • Suas chamadas incluírem XML.
  • Estiver se conectando a um serviço SOAP.

Se for necessário usar SNIPPET, revise as recomendações para minimizar o impacto no seu sistema antes de conectar-se a serviços web RESTful ou SOAP.

Integrações de fluxo de trabalho CRM Defina as integrações de fluxo de trabalho CRMClosed sistemas de Terceiros que gerenciam itens como contatos, informações de vendas, detalhes de suporte e históricos de casos. quando precisar fazer chamadas API para o CRM da sua organização. Isso é compatível com Agent Workspace (Agent), Agent Workspace (Embedded) (Agent Embedded) e Agent Workspace (Browser Extension) (Agent Integrated).

Limitações no tamanho dos dados retornados

A plataforma NiCE CXone permite que as API REST retornem até 32 KB de dados. Esse limite evita instabilidade e interrupções do cluster. Isto é rigorosamente aplicado.

Esse limite se aplica a qualquer método de conexão a serviços da web, incluindo a REST API ação, Integration Hub, e fazer chamadas com a ação SNIPPET. Se possível, use a ação REST API em vez da ação SNIPPET para suas REST API. A REST API tem um limite de retorno de 32 KB, mas ela consegue lidar com uma carga mais pesada do que o método SNIPPET consegue.

Para reduzir o tamanho dos dados retornados:

  • Filtrar os dados na resposta da API: Por exemplo, se você estiver usando a API de reporting NiCE para obter contatos, você pode filtrar os resultados pelo startDate e endDate do contato. Essa Chamada de API também permite retornar e limitar uma contagem de parte superior de itens. Consulte a documentação da API que acompanha sua integração de script para determinar quais filtragens você pode usar.

  • Atualize a solicitação de API para retornar somente os dados de que você precisa: Por exemplo, se você estiver usando a API de reporting NiCE para obter contatos, você pode usar os campos contactId ou agentId para retornar somente os dados relevantes. Consulte a documentação da API fornecida com a integração de script para determinar quais limites de dados você pode usar.

  • Compilar middleware: Se você não puder realizar nenhuma das opções anteriores, compile um middleware que realize a filtragem com base em critérios personalizados definidos por você. Se fizer isso, certifique-se de que o middleware não adicione latência à chamada.

 

Código de Erro -1

O código de erro -1 é um código interno usado para identificar que um erro foi encontrado em uma Chamada de API. mais especificamente, este código indica que esta é uma situação onde um código de status HTTP não será retornado ou onde o código é retornado mas não pode ser passado ao script.

A descrição de status que acompanha o código de erro -1 pode ajudá-lo a determinar o problema. As descrições de status que podem acompanhar este código são:

  • A solicitação foi interrompida: a operação atingiu o limite de tempo. A solicitação pode ou não ter sido processada. A validação deve ocorrer antes de configurar um loop em resposta a um código de status -1. Pode ser necessário alterar a configuração de limite de tempo na chamada usando a propriedade ProxyTimeoutSeconds.
  • Invalid JSON Primitive. The JSON parser was confused by the response. The response may have included invalid characters or wasn't JSON. Often, this error occurs when the response is sent in HTML. You can test the response in the snippet debugger. 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.

  • Os dados no nível raiz são inválidos. O analisador XML foi confundido pela resposta. A resposta pode ter incluído caracteres inválidos ou não era XML. Frequentemente, esse erro ocorre quando a resposta é enviada em HTML. O artigo da base de conhecimento REST API Response is not valid JSON or XMLA square with an arrow pointing from the center to the upper right corner. pode ajudar.

  • 'doctype' is an unexpected token. The expected token is 'DOCTYPE'. See Data at the root level is invalid in this list.

  • A tag de início 'br' na linha x posição x não corresponde à tag de fim de 'body'. Consulte Dados na raiz são inválidos nesta 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.

  • A conexão subjacente foi encerrada: não foi possível estabelecer uma relação de confiança para o canal seguro SSL/TLS. Consulte A conexão subjacente foi encerrada: ocorreu um erro inesperado em um envio nesta lista.

  • A solicitação foi abortada: não foi possível criar um canal seguro SSL/TLS. Consulte A conexão subjacente foi encerrada: ocorreu um erro inesperado em um envio nesta 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.