> For the complete documentation index, see [llms.txt](https://help-es.cosmobots.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help-es.cosmobots.io/bot-builder/integraciones/api.md).

# API

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.

![](https://lh5.googleusercontent.com/tBCjmcas5wqEttHGLi4yVA1gSG4IDjHLy_r0sQYA-FH4s98dB4gIAVKrpsKE2y2QMbQM7bdI-eI_nbWaJsmTvNIT8t3dT6Qwev1jbktMc02RJBr-9QTWqJnLdnqu5FOxjMVN6aW3Rg9gIcOPJA)

{% hint style="info" %}
Hay cuatro tipos de API: mensajes, conversaciones, intenciones y usuarios.
{% endhint %}

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.

![](https://lh4.googleusercontent.com/NRb-hl0UUbteScA9ldyo9WASqOdqSFkKzxRW6g7llfQr3J-zfpp6lpB9FnxjFv8hbKnJcyz0p-lMZtGwgm2-u9NsCt3Qlr8HlYEpLSaTTKpgKl4qez5aBCn9tAsdZIVY5WryjFqcoyCvahdHCw)

## **Autenticación**

En esta sección tendrá el **botid** y **token** necesarios para realizar la autenticación.

| **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**) |

## **Parámetros**

| **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.                                                                                                                         |

## **Retorno**

| **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) |

## **Exemplos**

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:

![](https://lh3.googleusercontent.com/SBcyNZQd9IT0hC62Z1YRhFS-YrC4Wo4D7O5EZZHPNJcV60WapKVW7MrRYbejF7RChp73kYA-lR7pip5-R3AJW-kwELxQwBqNYWlN2WGHzNqwrBDADVftN5QVbQllnLQRMWr5iF0YnpQwgdobxw)

En este caso enviamos al bot un "Hey There" de tipo texto. Ahora veamos cómo funcionará el Retorno:

![](https://lh4.googleusercontent.com/UY6VCE6hJi3sQWtnYx7UXFxW11_zOBnfzgwooVMjTrFONqUda35DTsPSVV21WSHlhyuKCPY30Qmd9FQuCI_3Jl1ua0b7LVs5_1qwEkKdb_FDpz113xuWRwrUsimTXU0sT6PWg_79joU4-4OvkA)