Aivo para desarrolladores

Crea tus propias integraciones

Endpoint Parameters

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

Configuración de Formularios

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

Integración tipo Data Form

Agrega una integración Data Form a las respuestas de tu bot y ofrece información personalizada. Este formulario pide datos a tus clientes, se conecta con el web service que uses y le devuelve la información solicitada, como el estado de su pedido o el saldo disponible. Para crearlos, sigue 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

Integración tipo Email Form

Utiliza una integración tipo Email Form para solicitar datos a tus clientes y recibirlos directamente en el correo electrónico especificado en la configuración del código JSON. Con este complemento, podrás captar leads u obtener detalles de un caso de soporte a través de tu bot.

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