API
Last updated
Last updated
La integración de API le permite acceder a cosmobots desde otro sistema, sirviendo como un canal que es responsable de procesar el envío y la devolución de mensajes entre el usuario y el bot.
Primero debe elegir qué tipo de API desea y habilitarla.
Hay cuatro tipos de API: mensajes, conversaciones, intenciones y usuarios.
Abajo hay un resumen de la API elegida, con el tipo de método, URL de la API, una breve descripción y la versión.
En esta sección tendrá el botid y token necesarios para realizar la autenticación.
La sección de ejemplos es para que usted entienda y pruebe, puede probar un texto sin formato, texto con los botones, y las tarjetas. Teniendo en cuenta las dos tablas anteriores de parámetros y retorno, vamos a analizar el ejemplo de abajo:
En este caso enviamos al bot un "Hey There" de tipo texto. Ahora veamos cómo funcionará el Retorno:
Nombre
Tipo
Descripción
botid
string
ID de tu bot en cosmobots: 1866e980-d661-15e7-b7bf-cb2aa1b94640 (ID ilustrativo)
token
string
Clave de token específica de este bot y se puede utilizar en cualquiera de los servicios de API disponibles: 2973f350-06db-11e9-92ad-5b7ab3d1568c (token ilustrativo)
Nombre
Tipo
Descripción
uid
string
ID del usuario que habla con el bot. Si es un nuevo usuario enviando su primera mensaje, enviar 'new_user'.
user
object
Si es un usuario nuevo, tiene la opción de enviar los siguientes campos predeterminados de usuario: first_name, last_name, email
type
string
Tipo de mensaje que se envía. Puede ser 5 opciones: text (texto simple), payload (Respuesta al hacer clic en un botón, por ejemplo), imagen (Contenido de una imagen), audio (Contenido de un audio), video (Contenido de un vídeo)
time
integer
Fecha y hora en milisegundos de cuando se envió el mensaje.
data
object
Dependiendo del tipo de mensaje definido anteriormente, aquí se colocará el contenido/valor de estos datos.
Nombre
Tipo
Descripción
uid
string
ID del usuario que habla con el bot. A su regreso, se le informará el ID creado para este usuario y que se debe utilizar en las siguientes llamadas.
time
integer
Fecha y hora en milisegundos de cuando se procesó el mensaje.
data
object
Aquí pondrás una matriz que contenga 1 o más tipos de datos devueltos. Existem 6 opções de tipo: text (texto simples), text_buttons (texto com botões), cards (cartões com imagem e botões), image (conteúdo de uma imagem), audio (conteúdo de um áudio), video (conteúdo de um vídeo)
