Aivo para desenvolvedores

Crie suas próprias integrações

Endpoint Parameters

Todas as estruturas para chamadas e envios aos endpoints devem ser no formato JSON.

Configuração de Formulários

Os steps são usados para criar endpoints que formam as integrações. Há diversos tipos de steps para ações específicas no bot.

Integração tipo Formulário de dados

Adicione uma integração tipo formulário de dados às respostas do seu bot e ofereça informação personalizada. Este formulário pede dados aos clientes, conecta com o webservice que você usa e devolve a informação solicitada, como o estado do seu pedido ou o saldo disponível. Para criá-los, siga o seguinte formato JSON:

Parâmetros:

  • type: O tipo de formato do valor de entrada.
  • label: A etiqueta de entrada do formulário em que indica ao cliente o valor que deve ser inserido neste campo.
  • ref: A referência que será usada na integração para obter o valor que o usuário entrar no campo requerido. Deve ser escrito em lowerCamelCase.
  • required: Indica se o campo é obrigatório ou não.

JSON: STEP FORM

Como a informação é recebida?

Os dados são enviados pelo método POST e em uma fila. Pode ser recebido por cada referência de entrada:

Código PHP:

Resposta que deve ser enviada ao bot:

Depois que os dados do formulário são recebidos e o cliente os processa, deve ser devolvida a resposta no formato JSON ao bot da seguinte forma:

  • answer: A resposta que o bot mostrará deve ser do tipo cadeia ou em formato JSON codificado.
  • answer_clean: A resposta que será mostrada nos canais como Facebook ou Whatsapp. Deve ser do tipo cadeia ou em formato de JSON codificado.
  • complements: Será do tipo JSON, caso deseje adicionar complementos à resposta, como botões. Pode encontrar o JSON na documentação do complemento.

Resposta sem complementos

Resposta com complementos

Integração tipo Formulário de e-mail

Utilize uma integração tipo formulário de e-mail para solicitar dados aos seus clientes e para recebê-los diretamente no e-mail especificado na configuração do código JSON. Com este complemento, você poderá captar leads ou obter detalhes de um caso de suporte através do seu bot.

Parâmetros:

  • emailTo: O e-mail do destinatário (sobrescrever os parâmetros do exemplo).
  • emailSubject: O assunto do email (sobrescrever os parâmetros do exemplo).
  • senderMessage: A mensagem que o usuário visualiza após o envio do endereço eletrônico.
  • required: Indica se o campo é obrigatório ou não.

JSON: EMAIL FORM