Configurando sua biblioteca de APIs no Bot Assist

Disponível apenas no plano Enterprise e Enterprise Omnichannel. 

O construtor do Assist bot permite que você faça extensas chamadas de API para qualquer sistema externo/interno para buscar ou enviar dados e exibi-los como parte da conversa do bot. Além disso, como Admins, você não precisa passar os parâmetros toda vez que acionar uma chamada de API a partir de um diálogo, em vez disso, pode reutilizá-los de um diálogo anterior ou qualquer outro, e também modificá-los facilmente configurando todos na biblioteca da API.

Cada chamada de API que precisa ser feita a partir de uma caixa de diálogo pode ser configurada na biblioteca de API e pode ser invocada escolhendo a opção ' Acionar API ' na guia Ações para a caixa de diálogo necessária.

Um guia rápido para criar uma nova API:

• Faça login na sua conta do Freshdesk como  administrador
• Vá para Admin > Produtividade do agente >  Assist bot  na configuração do Freddy

• Selecione o bot que deseja editar na página da lista de bots

• Clique no ícone ' API library ' na barra de navegação à direita

• O botão ' +Nova API ' permitirá configurar uma nova chamada de API
  
  

Configurando a API:

• Nome : dê à sua chamada de API um nome adequado.
• Nome da função URL/JS: Forneça a URL de retorno de chamada aqui. A opção do seletor de conteúdo [+] neste campo permitirá que você anexe valores das conversas ao URL de retorno de chamada. 
• Método: configure o tipo de chamada de API que você deseja fazer - GET, PUT, POST, DELETE ou uma função JS e, em seguida, passe a carga útil de acordo. Você também pode configurar um conteúdo de carga útil maior em um editor de texto expansível que formatará JSON automaticamente quando colado nele. Por exemplo, para criar um ticket em sua conta Freshdesk, passe o e-mail, prioridade, status, assunto e descrição em JSON. Você também pode usar espaços reservados usando o ícone +  no canto inferior direito.
  

• Adicionar cabeçalhos:  você pode autorizar suas APIs neste campo e também passar quaisquer parâmetros adicionais como cabeçalhos nesta seção.

• Teste:  para garantir que a chamada de API foi configurada corretamente, você pode realizar uma execução de teste de amostra, passar valores de teste para os campos dinâmicos que você configurou na carga útil (para métodos PUT, POST e JSON) e verificar os cabeçalhos de resposta.

• Adicione os parâmetros de resposta necessários: os atributos dos cabeçalhos de resposta podem ser referenciados em qualquer caixa de diálogo na conversa do chatbot.
  Por exemplo, se você deseja exibir o ID de status de um pedido, o campo ID dos cabeçalhos pode ser adicionado a este campo e usado nos diálogos subsequentes.

Se for necessária uma matriz de elementos, colchetes devem ser anexados a esse campo, para o exemplo abaixo: data[].id , data[].name

Para um determinado elemento em uma matriz, usar o número do índice exibirá o valor correspondente nesse campo: data[1].id exibirá o segundo valor no campo, do exemplo acima: 60002

Página da lista de APIs:

Na página da lista da biblioteca de APIs, você pode pesquisar as APIs que configurou usando seu nome. As APIs listadas informarão o tipo de ação que a API foi configurada para executar - GET ou POST, etc., mostrar quando a API foi criada e quando foi modificada pela última vez. Clicar no ícone 'mais' em uma API permitirá editá-la ou excluí-la.

Um guia rápido para usar as APIs:

• Faça login na sua  conta do Freshdesk como  administrador
• Vá para Admin > Produtividade do agente > Assist bot  na configuração do Freddy  

• Selecione o bot que deseja editar na página da lista de bots

• Clique no fluxo desejado desse bot

• Você pode adicionar uma resposta de API em 'Mensagem ou Pergunta' ou 'Ações' ou na guia 'Condições' com base no seu caso de uso
  • Em Mensagem ou Pergunta: Digite a mensagem ou pergunta a ser exibida aos agentes na caixa de texto e clique no ícone do seletor de conteúdo [+] e escolha 'APIs'. Você verá a lista de todas as APIs configuradas na biblioteca de APIs desse bot. Escolha a API necessária para anexá-la à caixa de texto.
    Por exemplo: se você estiver buscando o status do pedido, poderá configurar uma chamada de API para se conectar ao seu sistema de gerenciamento de pedidos e fazer referência ao status do pedido nos parâmetros de resposta.
    
    
  • Em Ações: Defina o ' Tipo de ação ' como ' Ativar API ' e selecione a API necessária na lista de todas as APIs configuradas na biblioteca de APIs desse bot.
    Por exemplo: se você estiver configurando uma resposta de API para obter a URL de uma página, poderá fazer referência a essa API em ações para que os agentes possam acessar a URL do bot.
    
    
  • Em Condições: Vá para a guia ' Condições ' para a caixa de diálogo necessária no fluxo do bot e clique no ícone do seletor de conteúdo [+] e escolha 'APIs' no menu suspenso. Você poderá ver a lista de todas as APIs configuradas na biblioteca de APIs desse bot. Selecione a chamada de API necessária e prossiga para escolher o valor de resposta. A resposta da API pode ser usada no corpo da condição e na seção de valor da condição.
    Por exemplo:No caso de um fluxo de assinatura simples, você pode obter o 'status' do pagamento da resposta da API e redirecionar os agentes para uma caixa de diálogo/fluxo diferente se o status for não pago ou configurar uma caixa de diálogo para exibir uma mensagem simples para os agentes se o status for pago para que possam comunicar o mesmo aos clientes.

Recentemente, atualizamos nossa marca em nossas ofertas e alteramos os nomes de nossos planos de preços. Se você se inscreveu antes de 9 de agosto de 2021, clique em Planos anteriores para visualizar seus planos aplicáveis. 
Garantimos que essa alteração não afetará sua experiência com o produto e nenhuma ação é necessária de sua parte.