Servicios externos (API)

Con el objetivo de una mayor flexibilidad en la construcción de asistentes, existe un recurso para la integración con los servicios corporativos. La integración se puede realizar mediante el registro de API o mediante la creación de servicios personalizados desde Senior X Platform. En este modelo de integración, el usuario informa la URL y los parámetros del servicio externo que va a consumir. Los parámetros pueden ser de tipo constante, en los que el usuario informa un valor fijo, o de tipo input, en los que el usuario recibe un valor tecleado por el mismo en el momento del diálogo.

Para realizar una integración con un servicio externo utilizando la interfaz:

1. Vaya a Senior X Platform > Bot Factory;
2. Seleccione un bot existente o cree uno nuevo;
3. Cree un nuevo asunto y haga clic en la pestañarespuesta del bot;
4. SeleccioneIntegración para el tipo de respuesta del bot;
5. Elija una opción de tipo de solicitud para definir el método HTTP utilizado para llamar al servicio;
6. En el campoURL de la API ingrese la URL del servicio.

Agregar parámetros a la solicitud

Es posible agregar dos tipos de parámetros para llamar a un servicio externo: entrada y constante.

• aporte: los parámetros de tipo de entrada son aquellos en los que el bot hará una pregunta y pasará la respuesta del usuario como un valor para la solicitud;
• Constante: valor que puede ser informado directamente en el registro de respuesta que será devuelto al usuario.

El bot utilizará los parámetros informados para el diálogo con el usuario:

Formato de respuesta estándar

La integración de Bot Factory admite llamadas REST, cuya entrada es un JSON en el cuerpo de la solicitud. Y como respuesta, Bot Factory espera que el servicio llamado devuelva en el cuerpo del mensaje un JSON con el siguiente formato:

{ "escribe": "TEXTO SIN FORMATO" || "HTML" || "BOTÓN" || "IMAGEN", " texto": [ "Texto de que el servicio volverá" ], "opciones": [ { " texto ":" título de la opción", "valor ":"Valor de respuesta a enviar cuando se selecciona la opción", "URL":"URL para abrir cuando se selecciona la opción "}], "imagen ": { " URL ":" URL de la imagen, disponible en la nube", "Enlace":" enlace para abrir al hacer clic en la imagen ", " texto ":" texto a enviar al hacer clic en la imagen " } }

Orientaciones

• || - significa o. En este caso, debe enviar una de las opciones, como un campo de texto (cadena);
• ? - significa que el campo es opcional, sin embargo, puede ser necesario informar al menos un campo opcional. Por ejemplo, al enviar el valor 'HTML' o 'PLAINTEXT' en el campo de tipo, es necesario rellenar el campo de texto con algo de texto.