Aivo para desarrolladores

Cree sus propios formularios

Endpoint Parameters

Parámetros de Endpoints

Parâmetros do Endpoints

Todas las estructuras utilizadas para las llamadas y envíos a los endpoints deben ser en formato JSON.

Form Configuration

Configuración de Formularios

Configuração de formulários

Los steps se usan para crear endpoints de las integraciones. Hay diferentes tipos de steps para acciones específicas en el bot.

Formulario tipo Data Form

Añada un formulario de datos a sus respuestas y proporcione a sus clientes información personalizada, como el estado de su pedido o el saldo de su tarjeta de crédito. Estos formularios solicitan datos tomados del servicio web que utilice y muestran esa información al cliente. Para crear un formulario puede utilizar el siguiente formato JSON:

Parámetros:

type: El tipo de formato del valor de entrada.
label: La etiqueta de entrada del formulario. Esta le indica al cliente el valor que va a ingresar en ese campo.
ref: La referencia que se utilizará en la integración para obtener el valor que el usuario introduzca en el campo requerido. Debe escribirse en minúsculas.
required: Indica si el campo es obligatorio o no.

JSON: STEP FORM

¿Cómo se recibe la información?

Los datos se envían por método POST y en una fila. Son recibidos por cada referencia de entrada:

Código PHP:

Respuesta que debe ser enviada al bot

Una vez que se reciben los datos del formulario y el cliente los procesa, debe devolver la respuesta en formato JSON al bot de la siguiente manera:

answer: Es la respuesta que se mostrará en el bot. Debe ser de tipo cadena o en formato JSON codificado.
answer_clean: Es la respuesta que se mostrará en canales como Facebook o Whatsapp. Debe ser de tipo cadena o en formato JSON codificado.
complements: Será de tipo JSON si deseas agregar complementos a la respuesta, como botones. Puedes encontrar los JSON en la documentación del complemento.

Respuesta sin complementos

Respuesta con complementos

Formulario tipo Email Form

Email Form te da la posibilidad de recopilar los datos de los clientes y enviarlos a una cuenta de correo electrónico configurada en el código JSON. Al añadirlos a las respuestas de tu bot, podrás generar leads u obtener detalles de casos de soporte fácilmente.

Parámetros:

emailTo: El correo electrónico del destinatario (sobrescribir los parámetros del ejemplo).
emailSubject: El asunto del correo (sobrescribir los parámetros del ejemplo).
senderMessage: El mensaje que el usuario ve una vez enviado el correo electrónico.
required: Indica si el campo es obligatorio o no.

JSON: EMAIL FORM