Categories
Módulos API

Configuração de canal API

Para criar um canal API, abra "Canais" - "Adicionar canal" - clique em "API".


Depois de adicionar um canal, quatro blocos para ajuste aparecem na página:

  • Básico (obrigatório) - "API", "Rastreamento de tickets", "Rastreamento de chat";
  • Para anexos (opcional) - "Configurações de anexos".
Bloco API

  • Nome do canal - insira o nome do canal que será exibido na lista geral de canais na seção "Canais";
  • URL de redirecionamento - seu webhook para o qual o canal da API do Usedesk deve enviar solicitações quando eventos específicos ocorrerem nos canais que estão sendo rastreados (você define sua lista em blocos "Rastreamento de tickets", "Rastreamento de bate-papos");
  • Solicitação JSON - marque a caixa se desejar converter a solicitação para o formato JSON;
  • Enviar para UTF-8 - marque a caixa de seleção para enviar a solicitação neste formato;
  • Canais de rastreamento - mova para a coluna direita os canais do Usedesk que este canal de API deve rastrear, os eventos serão marcados nos blocos "Rastreamento de tickets", "Rastreamento de chat". Deixe os canais desnecessários na coluna da esquerda. Essa distinção reduzirá a carga no canal API e eliminará os dados desnecessários.
Rastreamento de tickets e rastreamento de Blocos de bate-papo

Marque as caixas de seleção para os eventos em que o canal deve enviar solicitações ao seu URL de redirecionamento

Depois de fazer todas as alterações, clique em "Salvar".

Depois de salvar, os campos aparecem no bloco de API:

  • ID do aplicativo;
  • A chave secreta do aplicativo é um token de API - um canal por meio do qual você pode trabalhar com a API.

Bloquear "Configurando anexos"

Configure a transferência de arquivos preenchendo os seguintes campos:

  • Ativar - ativa / desativa a transferência de anexos;
  • URL - seu webhook para o qual o canal da API do Usedesk enviará os anexos;
  • Modo de trabalho - manual. A transferência dos anexos ainda não é feita automaticamente, é feita apenas manualmente pelo usuário;
  • Formato de transferência de anexos - selecione o formato para enviar anexos (link / base64);
  • Extensões de arquivo válidas - liste as extensões de arquivo que serão aceitas utilizando vírgulas. Campo vazio - todos os arquivos, exceto aqueles listados no campo "Extensões de arquivo proibidas" serão aceitos;
  • Extensões de arquivo proibidas - extensões de arquivo com lista utilizando vírgulas que não serão aceitas. Campo vazio - todos os arquivos serão aceitos, a menos que outros estejam listados no campo "Extensões de arquivo permitidas";
  • Impedir tipos de anexos;
  • Autorização básica;
  • Login;
  • Senha;
  • Tipos de anexo - adicione os tipos de anexo aos quais será atribuído automaticamente um ID para que a solicitação passe um ID de tipo, não com os nomes dos anexos. Ao transmitir o tipo de anexo desejado, o agente poderá selecionar um dos tipos de anexo na lista suspensa;
  • Canais - permitem que os anexos passem por um determinado canal. Importante: Um canal só pode ser selecionado em um canal API para anexos, ou seja, se dois canais API forem criados e um já tiver um canal selecionado, o mesmo canal não pode ser selecionado no segundo canal API.

Se o canal para o qual o recurso veio estiver conectado a algum canal API para transmissão de anexos, o botão "Enviar para CRM" é exibido ao lado do botão "Download" no modo de visualização.

Quando você enviar um anexo, uma notificação aparecerá no canto superior direito:

  • "Investimento transferido com sucesso" (verde) é um sucesso;
  • O texto do erro (vermelho), por exemplo: "Resposta incorreta do servidor" não é um sucesso.

O usuário seleciona manualmente os arquivos a serem transferidos e pressiona o botão "Enviar para CRM".

A resposta é retornada no formato JSON: {sucesso: verdadeiro} e {sucesso: falso}. Qualquer outra resposta é considerada um erro.