Aivo para desenvolvedores

Cria os teus próprios formulários

Endpoint Parameters

Parámetros de Endpoints

Parâmetros do Endpoints

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

Form Configuration

Configuración de Formularios

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.

Formulário tipo Data Form

Adicione um Formulário de Dados às suas respostas e forneça aos seus clientes informações personalizadas, como o estado da sua encomenda ou o saldo do seu cartão de crédito. Estes formulários solicitam dados retirados do serviço web que utiliza e mostram essa informação ao cliente. Para criar um formulário, pode utilizar 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

Formulário tipo E-mail Form

O formulário de e-mail dá-lhe a possibilidade de recolher dados de clientes e enviá-los para uma conta de e-mail configurada no código JSON. Ao adicioná-los às respostas do seu bot, será capaz de gerar leads ou obter detalhes de casos de suporte facilmente.

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