Criar Integrações
- 14/06/2024
Para Criar Integrações respeite os critérios descritos no passo a passo:
- Acesse Configurações > Integrações.
- Clique no botão +Novo.
-
Preencha os campos:
■ Nome: que identificará a Integração.
■ Domínio: no qual a Integração será utilizada.
■ Tipo de integração: Onde será feita a integração com a chamada.
*O tipo de Integração já aparecerá preenchido com o padrão “Tela do atendente”.
■ Habilitar Autenticação: Ao ativar o botão, a seção Autenticação será carregada na tela e mostrará o campo “Tipo de autenticação”.
Selecione o desejado e campos correspondentes a cada um deles serão apresentados como a seguir:
• Token: Exibe o campo "token". Informe o que será utilizado para autenticação.
• Login: Quando o tipo login for selecionado, a tela de Integrações mostrará os campos:
- Tipo de conteúdo para autenticação: Escolha se será FORM URL Encoded (application/x-www-form-urlenconded) ou JSON (application/json).
- URL para autenticação: Endereço webque será utilizado pela aplicação para realizar a autenticação.
- Variável de retorno: Deve ser preenchido com o nome que será utilizado no retorno da requisição ao endpoint que contém o token do usuário logado.
- Parâmetros para login: Trata-se de uma tabela utilizada para inserção de chave/valor (key/value) com as informações adicionais para logar um usuário a um sistema, com a finalidade de obter um token válido.
Informe as chaves e os correspondentes valores de login que serão utilizados para verificar a identidade do usuário.
*Pressione o ícone “+” para cada chave e valor a serem adicionados.
- Pressione Salvar e continuar no topo direito da tela para seguir para a próxima tela de cadastro da integração.
-
Defina os parâmetros da seção Execução. Ou seja, o(s) momento(s) em que endpoints da integração será(ão) executado(s).
Para isso, preencha os dados dos campos:
■ Eventos de Execução: Selecione se deseja que o endpoint seja executado quando a chamada estiver Tocando, quando for Atendida, ou, ao ser Desligada.
É possível cadastrar mais de um endpoint por evento.
■ Método HTTP: Método de requisição que será executado no(s) endpoint(s) da Integração.
Selecione se será GET, PATCH, POST ou PUT.
■ URL base: do endpoint a ser executado. Deve iniciar com http:// ou https://.
IMPORTANTE IMPORTANTE: O campo “URL Base” permitirá a utilização de parâmetros de retorno de API e de variáveis SIP na sua composição.Exemplo de retorno de API de terceiro
URL base: {{ANSWERED.1.records[].retorno_url}}
Exemplo de uso de variável SIP
URL base: https://meucrm.com/{{verto_h_UNITY_TICKET/update}}
*Confira mais detalhes em Reaproveitamento de Requisições
■ Tipo de conteúdo: Selecione se será JSON (Application/json) ou FORM URL Encoded (application/x-www-form-urlencoded).
A depender do Evento de Execução selecionado (Tocando, Atendida ou Desligada) serão exibidos os seguintes botões:
• Nova aba de navegação: Exibido para todos os tipos de Evento de Execução, quando o “Método HTTP” selecionado é o GET. Habilite o botão (cor verde) para, quando o script for executado, uma nova aba seja aberta no navegador (browser) do Atendente com o URL formado na requisição.
• Enviar Gravação: É mostrado apenas quando o Evento de Execução escolhido é (chamada) Desligada. Habilite o botão (cor verde), para que a gravação da chamada seja registrada.
Ao fazer isso, os campos “Chave para gravação da chamada” e “Método de envio de gravação” serão carregados para informar: A chave para gravação da chamada e o local onde o URL da gravação da chamada será armazenado.
O armazenamento pode ser feito:
• Na API: Método padrão. Utilizado para enviar o link de download da gravação via aplicação.
• Manager: Se este método for selecionado, ao clicar no link da gravação o usuário será direcionado à tela do menu Record > Ouvir gravações, da plataforma de Contact Center (Smartspace Manager).
Para ouvir ou fazer download da gravação é necessário que ele tenha acesso habilitado para essas funcionalidades em seu Perfil de usuário.
-
■ Parâmetros para integração: Nessa seção pressione o botão “+” para adicionar os parâmetros que serão usados no(s) endpoint(s). Seja no URL para o método GET ou no body, para o método POST, PATCH ou PUT.
• Chave do URL: identificador que receberá o valor da variável do SIP e o esperado no URL da Integração.
• Chave da variável SIP: identificador do valor retornado pelo SIP. Este valor será atribuído à chave do URL, na execução do(s) endpoint(s).
IMPORTANTE IMPORTANTEA seção Parâmetros para integração sempre apresentará a primeira linha para inserção de “Chave url” e “Chave da variável sip” para ser preenchida, com a finalidade de evitar a adição de qualquer evento sem informar os parâmetros.
Além disso, sempre que adicionar mais linhas e não preencher as chaves de parâmetros, ao pressionar +Adicionar Execução, as linhas vazias serão exibidas em vermelho para sinalizar que não é possível inserir campos vazios em parâmetros.
A regra também se aplica à edição de Integrações já cadastradas.
-
Após adicionar todos os Parâmetros para integração, pressione +Adicionar Execução para que a requisição seja inserida no Evento de Execução.
* Os eventos e seus respectivos parâmetros serão listados abaixo da seção Execução.
-
Clique em Salvar no topo direito da tela para que a configuração seja registrada. Ou, Cancelar, caso desista de criar a Integração.
- O botão Habilitar Autenticação tem relação direta com o botão Nova aba de navegação. Quando Nova aba de navegação estiver DESABILITADO, o endpoint configurado no campo “URL Base” poderá ou não ser utilizado considerando o botão Habilitar Autenticação. Caso Habilitar Autenticação esteja ativo, será necessário fazer login para obter o token ou usar o token informado na configuração.
- As configurações feitas na tela de Integrações serão utilizadas na tela de Atendimento, pelo menu Metrics > Atendentes > Atendimento. A execução acontecerá no momento definido em Eventos de Execução (chamada Tocando, Atendida ou Desligada).
