Customizações

Chamando serviços externos para responder uma pergunta

229 views 08/10/2019 11/10/2019 paulo-weber 1

Um chatbot existe para diversos propósitos, desde esclarecer dúvidas sobre o saldo de férias de determinado colaborador até a automação de atendimentos. Para isto é necessário que ele seja integrado com sistemas como: HCM, ERPs, CRMs e entre outros

A forma mais comum de integração é o uso de APIS, que buscam dados ou realizam ações em outros sistemas. Por isso, o BotFactory disponibilizou o tipo de resposta integração, no qual é possível fazer com que o bot responda perguntas relacionadas a estes sistemas.

 

Agora vamos entender como fazer a integração

Integrando BotFactory com serviço externo

Para realizar uma integração com serviço externo utilizando a interface:

  • Acesse o seu ambiente Senior X na aba Senior X Platform > Bot Factory;
  • Selecione um bot existente ou crie um novo;
  • Crie um novo assunto;
  • Na criação do assunto, clique na aba Resposta do bot;
  • Seleciona Integração para ser o tipo de resposta do bot;
  • Escolha uma opção do Tipo de requisição para definir o método HTTP utilizado para chamar o serviço;
  • No campo Url da Api insira a URL do serviço.

Demonstração de integração com serviço externo

O exemplo a seguir é feito com uma resposta fixa, com objetivo de testar o retorno de um JSON apropriado.

Este exemplo é apenas um teste e não deve ser utilizado em produção.

Primeiro, você precisa cadastrar um novo assunto com as informações necessárias, conforme demonstrado abaixo:

 

Com os valores cadastrados acima, o bot terá o seguinte comportamento:

 

Adicionando parâmetros na requisição

É possível adicionar dois tipos de parâmetros para realizar a chamada de um serviço externo: input e constante.

  • Input: parâmetros do tipo input são aqueles que o bot irá fazer uma pergunta e passará a resposta do usuário como valor para a requisição;
  • Constante: valor que pode ser informado diretamente no cadastro da resposta que será retornada para o usuário.

O bot utilizará os parâmetros informados para o diálogo com o usuário:

 

Formato padrão de resposta

A integração do BotFactory suporta chamadas REST, cuja entrada é um JSON no corpo da requisição. E como resposta, o BotFactory espera que o serviço chamado retorne no corpo da mensagem um JSON com o seguinte formato:

{
	"type":"PLAINTEXT" || "HTML" || "BUTTON" || "IMAGE",
	"text"?:[
		"Texto que o serviço vai retornar"
	],
	"options"?:[
		{
			"text":"Título da opção",
			"value"?:"Valor da resposta a ser enviada quando a opção for selecionada",
			"url"?:"Url a ser aberta quando a opção for selecionada"
		}
	],
	"image"?:{
		"url":"url da imagem, disponível na nuvem",
		"link"?:"link a ser aberto quando clicar na imagem",
		"text"?:"texto a enviar quando clicar na imagem"
	}
}

 

  • || significa ou. Neste caso, deve mandar alguma das opções, como sendo um campo do tipo texto (string)
  • ? significa que o campo é opcional, porém, pode ser necessário informar pelo menos um campo opcional. Por exemplo, ao enviar o valor ‘HTML’ ou ‘PLAINTEXT’ no campo type, é necessário preencher o campo text com algum texto.

Este artigo foi útil para você?