API

La API te permite enviar cualquier bloque o flujo mediante una solicitud POST API. También te permite enviar bloques a contactos con propiedades específicas.

Aquí tienes un ejemplo de una solicitud típica:

javascript
https://api.chatfuel.com/bots/<BOT_ID>/users/<USER_ID>/send?chatfuel_token=<TOKEN>&chatfuel_flow_name=<FLOW_NAME>&<USER_ATTRIBUTE_1>=<VALUE_1>&<USER_ATTRIBUTE_2>=<VALUE_2>

Con todos los datos completados, tu solicitud debería verse algo así:

javascript
https://api.chatfuel.com/bots/612899e1a6ec6f5e0f2fe556/users/5949225915148689/send?chatfuel_token=jPvO73OSpKfQD9hwEb6EnrdgUwAHKQVEHHsNA25IbXEcVLA68myGXzjdXODaGhyS&chatfuel_block_id=63809fc68e17052f16c3ca01

Parámetros y valores

Requeridos

Parámetros:

chatfuel_token

Uno de estos parámetros de enrutamiento:

chatfuel_flow_name
chatfuel_block_name
chatfuel_block_id

Valores URL:

<BOT_ID>

<USER_ID>

Opcionales

Puedes añadir estos para personalizar tu solicitud:

chatfuel_message_tag - Permite enviar mensajes fuera de la ventana de 24 horas 🡽

<USER_ATTRIBUTE>=<VALUE> - Establece propiedades personalizadas del usuario

Lista de parámetros y valores disponibles

Parámetro	Descripción	Tipo
`chatfuel_token`	Token único para tu empresa	Requerido
`<BOT_ID>`	ID de tu empresa	Requerido
`<USER_ID>`	ID de un contacto al que quieres enviar mensaje	Requerido
`chatfuel_flow_name`	Nombre de tu flujo	Requerido*
`chatfuel_block_name`	Nombre de tu bloque	Requerido*
`chatfuel_block_id`	ID de tu bloque o flujo	Requerido*
`chatfuel_message_tag`	Etiqueta para enviar mensajes fuera de la ventana de 24 horas 🡽	Opcional
`<USER ATTRIBUTE>`	Nombre y valor de una propiedad del contacto (Ejemplo: `customertype=new`)	Opcional
`tags`	Lista de etiquetas para establecer en un contacto (Ejemplo: `tags=Helen,female,new_customer`). Las nuevas etiquetas reemplazarán a las existentes.	Opcional

* Debes incluir uno de estos tres parámetros de enrutamiento en tu solicitud: chatfuel_flow_name, chatfuel_block_name, o chatfuel_block_id*

Cómo obtener el token de Chatfuel

Ve a Configuración ➜ API.

Copiar clave API para copiar tu token.

Si necesitas un nuevo token, haz clic en Restablecer.

Cómo obtener el ID de la empresa

Un ID de empresa es una combinación única de números y letras. Se ve así: 612899e1a6ec6f5e0f2fe556. Para obtenerlo:

Abre IA y Automatización.

Haz clic en la barra de direcciones de tu navegador.

Copia el ID de tu empresa.

Cómo obtener un ID de usuario

Hay dos tipos de ID que puedes usar para el valor URL <USER_ID>: user id o chatfuel user id. La forma más fácil de obtenerlos es buscarlos en la pestaña Personas.

Abre Chat en vivo.

Haz clic en tu nombre en la lista.

Encuentra y copia ya sea un user id o chatfuel user id.

Cómo obtener el ID para bloque o flujo

Un ID de bloque o flujo se ve similar a un ID de empresa: 61fbd2f0a2d3e66f2ed59de7.

Abre IA y Automatización.

Abre tu flujo.

Haz clic en la barra de direcciones de tu navegador.

Copia el ID de tu flujo.

Para bloques:

Elige tu bloque.

Copia el ID junto al ID del flujo.

Reglas

Puedes enviar hasta 25 RPS por bot a la API de Difusión

Todos los parámetros que comienzan con chatfuel_ están reservados y no deben usarse