Constructor de API
Algunas funciones de solicitud de API se pueden ejecutar en la Calculadora.
Las solicitudes se envían mediante el POST o GET método a una URL en el siguiente formato:
https://chatter.mavibot.ai/api/{api_key}/{action}
Dónde:
api_key — la clave de acceso a la API generada en la configuración del proyecto.
Para usar el token en una solicitud URL, primero necesitas generar una clave API.
Las instrucciones para hacerlo se proporcionan en la sección "Generación de una clave API". ссылка
Al copiar una URL de esta página, puede aparecer un espacio y debe eliminarse.
Ejemplo de un enlace incorrecto: https://chatter.mavibot.pro /api/callback
Si el espacio después de .pro permanece, la solicitud no funcionará.
No uses caracteres prohibidos al enviar una solicitud GET.
Asegúrate de entender el formato correcto para las solicitudes GET.
Cómo generar una clave API
La antigua función de generación de claves API sigue funcionando como antes, pero no está disponible para nuevos proyectos.
Si tu proyecto ya tiene claves API generadas sin la configuración de acceso descrita en esta sección, esas claves API existentes seguirán funcionando normalmente.
Si necesitas generar nuevas claves, usa la configuración actualizada.
Para generar una clave API, ve a la configuración del proyecto:
A continuación, ve a la sección "Integraciones":
Encontrarás el botón "Agregar clave API" en la sección "Integraciones":
Después de hacer clic en el botón, se abrirá una ventana modal con la configuración de acceso y las opciones de generación de la clave API:
A continuación, debes seleccionar los permisos de acceso para la clave API:
La función de la API funcionará según los permisos de acceso que selecciones.
¡Ten en cuenta!
La función de la API depende de los permisos de acceso que establezcas: si generas una clave API con acceso de solo lectura a la información del cliente y luego la usas para enviar un mensaje a un cliente o modificar sus variables, la solicitud de la API fallará. El permiso requerido para cada solicitud de API se especifica en la tarjeta de solicitud de API:
A continuación, introduce un nombre para la clave API:
Genera la clave API haciendo clic en el botón "Generar":
Después de eso, haz clic en "Listo" y la clave api se añadirá a la sección:
Puedes añadir tantas claves API como necesites, asignando diferentes permisos de acceso a cada una.
A continuación, debes establecer una clave principal del proyecto. Esto te permite usar la clave en una URL de solicitud con el marcador #{api_key}.
Para ello, haz clic en el botón "{+}" a la derecha de la clave API deseada:
Luego aparecerá una etiqueta junto a la clave, indicando que es la clave principal del proyecto.
Puedes acceder a la clave principal del proyecto a través de api_key: simplemente genera la clave requerida, configura sus permisos y asígnala como la clave principal del proyecto. Luego, en la Calculadora, usa la URL de solicitud con el marcador #{api_key}, que contendrá el valor de la clave principal del proyecto.
Cualquier otra clave generada con configuración de acceso se considerará clave secundaria. En la URL de solicitud, puedes usar su valor en lugar de #{api_key}. Para hacerlo, copia el valor de la clave secundaria:
y pégalo en la URL de solicitud en lugar de #{api_key}:
Una clave API generada usando el método antiguo se establece como la clave principal del proyecto por defecto y tiene permisos completos.
¡Nota!
Si eliminas la clave establecida como clave principal del proyecto, tendrás que designar manualmente una nueva clave como principal.
¡Ten en cuenta!
Si tienes claves API generadas usando el método antiguo, seguirán funcionando normalmente. No es posible generar nuevas claves API del tipo antiguo.
Cómo recibir mensajes en la URL del Webhook especificada en la configuración del proyecto
Cada mensaje entrante o saliente se enviará como la siguiente solicitud JSON POST:
Si una solicitud devuelve un error, no se reintentará. Incluso si el servidor devuelve errores, las notificaciones seguirán enviándose.
Cómo crear una solicitud JSON
Ve a la configuración del bloque donde se registrarán los datos en la tabla.
Añade una sección Solicitud API.
Selecciona POST-JSON como tipo de solicitud.
Luego procede a completar los campos de la solicitud:
URL de la solicitud — la ruta a la función que se llamará. En la documentación, esto siempre se muestra en la primera línea junto al tipo de solicitud:
Valores guardados — una lista de parámetros de respuesta con los nombres de las variables donde deben almacenarse los resultados, en el siguiente formato:
request_parameter -> tu_variable
Si la respuesta contiene parámetros con una estructura compleja, analízalos de la siguiente manera:
"cell_number":{"row":4,"col":2} cell_number|row ->String; cell_number|col -> Column
Encabezados de la solicitud — complétalo si es necesario. Esto suele incluir el formato de datos y/o el token de acceso.
Parámetros JSON — el cuerpo de la solicitud, donde especificas los parámetros de datos en formato JSON. Ejemplo:
{"client_id": "#{recipient_id_in_builder}", "message":"¡Hola!"}
Para entender la estructura de la respuesta, escribe #{custom_answer} en el campo Message para mostrar el valor de la variable.
A continuación, la documentación enumera los parámetros permitidos en la sección "Body":
Cómo usar un webhook universal
Los métodos enumerados ahora se pueden ejecutar como solicitudes POST o GET.
Anteriormente, nuestros métodos tenían parámetros fijos (como client_id y fb_id) para activar acciones del suscriptor, lo que imponía ciertas limitaciones al integrarse con servicios de terceros.
Ahora puedes especificar qué parámetro de solicitud debe usar SaleBot para encontrar el ID del usuario. Usa un parámetro con el prefijo value_, por ejemplo, value_user_id o value_group_id.
Además, el método de envío callback ahora también puede activarse usando el correo electrónico del cliente (client_email) o el número de teléfono (client_phone).
El callback, fb_callback, y whatsapp_callback los métodos no están vinculados a nombres de parámetros específicos. Puedes especificar qué parámetro contiene el número de teléfono, el correo electrónico o el ID del cliente.
Esto es útil al configurar la recepción de webhooks desde un sitio web.
Para especificar qué variable contiene client_id, usa el parámetro value_client_id y proporciona el nombre del parámetro que contiene este valor.
Para especificar qué variable contiene el número de teléfono, usa value_phone.
Para especificar qué variable contiene el correo electrónico, usa value_email.
Para especificar qué variable contiene el user_id, usa value_user_id.
Para especificar qué variable contiene el group_id, usa value_group_id.
Para especificar la variable que contiene el propio mensaje en el webhook, usa value_message (se pasa de la misma manera que los demás parámetros).
Ejemplo:
En la dirección, especifica value_client_id = my_client.
https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback?value_client_id=my_client
{"my_client":49177759, "message":"Hello world"}
La solicitud será equivalente a la siguiente:
https://chatter.mavibot.pro/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback
{"client_id":49177759, "message":"Hello world"}
Como puedes ver, el nombre del parámetro que contiene el valor va precedido por value_.
¡Ten en cuenta!
Algunos eventos generan notificaciones del sistema dentro del proyecto.
Por ejemplo, hay notificaciones del sistema con un campo message que no está vacío pero que no contiene texto del cliente.
Al mismo tiempo, el proyecto también puede generar hooks de mensaje con contenido específico, como "message: new_chat_member".
Por lo tanto, es importante comprobar el contenido: será una notificación del sistema o un hook para un evento específico.
Cómo iniciar el bot
Iniciar el bot
POST https://chatter.mavibot.ai/api/#{api_key}/callback
URL de la solicitud: https://chatter.mavibot.ai/api/#{api_key}/callback
Este método puede usarse para activar un embudo para un cliente o confirmar una acción en un recurso externo. El cliente no verá este mensaje.
Ten en cuenta: cualquier parámetro que pases adicionalmente se guardará en la variable
El método callback ahora también puede activarse usando el correo electrónico del cliente (client_email) o el número de teléfono (client_phone).
Permiso de acceso al generar una clave: "Permiso para modificar/eliminar la información del cliente".
Ruta
api key* - token de acceso
Cuerpo
client_phone - número de teléfono usado para buscar al cliente
client_email - correo electrónico usado para buscar al cliente
client_id - ID del cliente en el generador
message - texto del mensaje
resume_bot - True (parámetro opcional). Si el bot está pausado, esto se usa para reanudarlo.
Ejemplo: resume_bot = True
time_shift - número. Si se especifica, el mensaje se enviará después del número dado de segundos desde el momento actual.
send_time - fecha y hora en el formato "%Y-%m-%d %H:%M:%S" (por ejemplo, "2024-10-16 13:15:59"). Esto establece la fecha y hora de envío del mensaje. Si se especifican tanto time_shift como send_time, time_shift tendrá prioridad.
Iniciar el bot usando un número de WhatsApp
POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_callback
URL de solicitud: https://chatter.mavibot.ai/api/<api_key>/whatsapp_callback
Este método puede activar el bot de WhatsApp después de que un cliente se registre en el sitio web o envíe una solicitud con su número de teléfono.
Ten en cuenta: cualquier parámetro que pases adicionalmente se guardará en la variable
Permiso de acceso al generar una clave: "Permiso para modificar o eliminar la información del cliente".
Ruta
api key* - token de acceso
Cuerpo
name - nombre del cliente message - texto del mensaje phone - número de teléfono del cliente bot_id - ID del bot resume_bot - True (parámetro opcional). Si el bot está pausado, úsalo para reanudarlo. Ejemplo: resume_bot = True
time_shift - número. Si se especifica, el mensaje se enviará después del número dado de segundos desde el momento actual.
send_time - fecha y hora en el formato "%Y-%m-%d %H:%M:%S" (por ejemplo, "2024-10-16 13:15:59"). Esto establece la fecha y hora de envío del mensaje. Si se especifican tanto time_shift como send_time, time_shift tendrá prioridad.
Iniciar el bot usando un ID de Telegram
POST https://chatter.mavibot.pro/api/#{api_key}/tg_callback
URL de solicitud: https://chatter.mavibot.pro/api/#{api_key}/tg_callback
Este método se puede usar para activar un embudo para un cliente o confirmar una acción en un sitio web externo. El cliente no verá este mensaje.
Ten en cuenta que cualquier parámetro que pases adicionalmente se guardará en variables.
Permiso de acceso al generar una clave: "Permiso para modificar o eliminar la información del cliente".
Ruta
api key* - token de acceso
Cuerpo
message - texto del mensaje user_id - ID de usuario de Telegram group_id - nombre del bot (terminado en bot) resume_bot - True (parámetro opcional). Si el bot está pausado, úsalo para reanudarlo. Ejemplo: resume_bot = True
time_shift - número. Si se especifica, el mensaje se enviará después del número dado de segundos desde el momento actual.
send_time - fecha y hora en el formato "%Y-%m-%d %H:%M:%S" (por ejemplo, "2024-10-16 13:15:59"). Esto establece la fecha y hora de envío del mensaje. Si se especifican tanto time_shift como send_time, time_shift tendrá prioridad.
Enviar mensajes callback a una lista de clientes por platform_id
POST https://chatter.mavibot.ai/api/#{api_key}/send_callback_by_platform_id
URL de solicitud: https://chatter.mavibot.ai/api/#{api_key}/send_callback_by_platform_id
Cuando se encuentren en el proyecto clientes con un platform_id de la lista, se enviará un callback con el texto del campo callback_text. Límite: 1 solicitud = máximo 300 envíos
Ejemplo de parámetros de solicitud: {"platform_ids":[407184121, "79609879898", "2rwewefw"], "callback_text": "test_callback"}
Permiso de acceso al generar una clave: "Permiso para modificar o eliminar la información del cliente".
Ruta
api key* - token de acceso
Cuerpo
platform_ids - lista de IDs de clientes en el mensajero callback_text - texto del callback group_id - ID del bot
time_shift - número. Si se especifica, el mensaje se enviará después del número dado de segundos desde el momento actual.
send_time - fecha y hora en el formato "%Y-%m-%d %H:%M:%S" (por ejemplo, "2024-10-16 13:15:59"). Esto establece la fecha y hora de envío del mensaje. Si se especifican tanto time_shift como send_time, time_shift tendrá prioridad.
Enviar un mensaje callback a un cliente por correo electrónico
POST https://chatter.mavibot.ai/api/#{api_key}/email_callback
URL de solicitud: https://chatter.mavibot.ai/api/#{api_key}/email_callback
Este método puede activar el bot de correo electrónico después de que un cliente se registre en el sitio web o envíe una solicitud con su correo electrónico. El método localizará el correo del cliente o lo creará si no se encuentra.
Permiso de acceso al generar una clave: "Permiso para modificar o eliminar la información del cliente".
Ten en cuenta: cualquier parámetro que pases adicionalmente se guardará en la variable
Ruta
api key* - token de acceso
Cuerpo
name - nombre del cliente message - texto del mensaje email - dirección de correo electrónico email_id_bot - dirección de correo del bot resume_bot - True (parámetro opcional).
Si el bot está pausado, úsalo para reanudarlo. Ejemplo: resume_bot = True
time_shift - número. Si se especifica, el mensaje se enviará después del número dado de segundos desde el momento actual.
send_time - fecha y hora en el formato "%Y-%m-%d %H:%M:%S" (por ejemplo, "2024-10-16 13:15:59"). Esto establece la fecha y hora de envío del mensaje. Si se especifican tanto time_shift como send_time, time_shift tendrá prioridad.
Cómo trabajar con mensajes
Parámetros de envío de mensajes
attachment_type — puede ser: imagen, video, enlace, archivo o audio. Al enviar un archivo adjunto, el parámetro message es opcional.
buttons — define los botones que se adjuntarán al mensaje. El formato de los botones coincide con la configuración avanzada de botones.
Los botones pueden pasarse de dos maneras: con una pista para los mensajeros que no admiten botones, o sin ella.
Ejemplo del parámetro buttons:
Enviar un mensaje a un cliente
POST https://chatter.mavibot.ai/api/#{api_key}/message
URL de la solicitud: https://chatter.mavibot.ai/api/#{api_key}/message
Este método puede usarse para enviar mensajes de notificación. El parámetro message es obligatorio, a menos que estés enviando un archivo. Si estás enviando un archivo, el texto es opcional.
Permiso de acceso al generar una clave: "Permiso para modificar o eliminar la información del cliente".
Ruta
api key* - token de acceso
Cuerpo
message_id - número de bloque para el envío message - texto del mensaje client_id - ID del cliente en el generador attachment_type - tipo de visualización del archivo. Requerido si se proporciona attachment_url. attachment_url - URL del archivo buttons - botones
time_shift - número. Si se especifica, el mensaje se enviará después del número dado de segundos desde el momento actual.
send_time - fecha y hora en el formato "%Y-%m-%d %H:%M:%S" (por ejemplo, "2024-10-16 13:15:59"). Esto establece la fecha y hora de envío del mensaje. Si se especifican tanto time_shift como send_time, time_shift tendrá prioridad.
Enviar un mensaje en WhatsApp
POST https://chatter.salebot.pro/api/<api_key>/whatsapp_message
URL de solicitud: https://chatter.mavibot.pro/api/<api_key>/whatsapp_message
Te permite enviar un mensaje en nombre del bot conectado al número especificado. El whatsapp_bot_id debe tomarse de la sección "Mensajeros y chats". Cada cuenta de WhatsApp conectada recibe un identificador único por parte del generador.
Permiso de acceso al generar una clave: "Permiso para modificar o eliminar la información del cliente".
Ruta
api key* - token de acceso
Cuerpo
message_id - número de bloque para el envío whatsapp_bot_id - ID del bot de WhatsApp desde el que debe enviarse el mensaje attachment_url - URL del archivo attachment_type - tipo de visualización del archivo. Requerido si se proporciona attachment_url. message - texto del mensaje phone - número de teléfono del destinatario
time_shift - número. Si se especifica, el mensaje se enviará después del número dado de segundos desde el momento actual.
send_time - fecha y hora en el formato "%Y-%m-%d %H:%M:%S" (por ejemplo, "2024-10-16 13:15:59"). Esto establece la fecha y hora de envío del mensaje. Si se especifican tanto time_shift como send_time, time_shift tendrá prioridad.
Envío masivo de mensajes
POST https://chatter.mavibot.ai/api/#{api_key}/broadcast
URL de solicitud: https://chatter.mavibot.ai/api/#{api_key}/broadcast
Este método te permite iniciar una difusión.
Puedes usar una de las siguientes opciones mutuamente excluyentes:
parámetro list — la difusión se enviará a la lista especificada de clientes.
parámetro clients — la difusión se enviará a un array de IDs de clientes.
parámetros platform_ids y group_id — la difusión se enviará a un array de platform_ids (IDs de mensajero) para el bot especificado (group_id).
Si no se proporciona ninguno de los parámetros anteriores, la difusión no se enviará.
Parámetros requeridos: message (y/o attachment_type y attachment_url) o message_id.
Permiso de acceso al generar una clave: "Permiso para modificar o eliminar la información del cliente".
Ruta
api key* - token de acceso
Cuerpo
list - número de lista al que debe enviarse la difusión
clients - IDs de clientes en el generador
message - texto del mensaje
platform_ids - IDs de destinatarios en el mensajero. Debe usarse junto con el parámetro required group_id
group_id - requerido solo al usar platform_ids. Se ignora con otras opciones. Especifica el bot para enviar a los platform_ids dados
attachment_url - URL del archivo
attachment_type - tipo de visualización del archivo. Requerido si se proporciona attachment_url.
buttons - botones
message_id - número de bloque para el envío
shift — número de segundos entre mensajes. El valor predeterminado es 0.2.
time_shift - número. Si se especifica, el mensaje se enviará después del número dado de segundos desde el momento actual.
send_time - fecha y hora en el formato "%Y-%m-%d %H:%M:%S" (por ejemplo, "2024-10-16 13:15:59"). Esto establece la fecha y hora de envío del mensaje. Si se especifican tanto time_shift como send_time, time_shift tendrá prioridad.
Recuperar historial de mensajes
GET https://chatter.mavibot.ai/api/#{api_key}/get_history?client_id=
URL de solicitud: https://chatter.mavibot.ai/api/#{api_key}/get_history?client_id=
El parámetro client_id se puede obtener aquí. ссылка
Permiso de acceso al generar la clave: "Permiso para leer la información del cliente".
Ruta
api key* - token de acceso
Cuerpo
client_id - ID del cliente
limit - número de elementos en la respuesta. Predeterminado: 2000, máximo: 2000
start_date - fecha de inicio del período de selección (requerido si se especifica stop_date), formato: dd.mm.yyyy
stop_date - fecha de fin del período de selección (requerido si se especifica start_date), formato: dd.mm.yyyy
Borrar historial de mensajes
GET https://chatter.mavibot.ai/api/#{api_key}/clear_history?client_id=
URL de solicitud: https://chatter.mavibot.ai/api/#{api_key}/clear_history?client_id=
Elimina el historial del chat
Permiso de acceso al generar una clave: "Permiso para modificar/eliminar la información del cliente".
Ruta
api key* - token de acceso
Cuerpo
client_id - ID del cliente
Cómo asignar clientes
Asignar un cliente a un empleado
POST https://chatter.mavibot.ai/api/#{api_key}/assign_to_user
URL de solicitud: https://chatter.mavibot.ai/api/#{api_key}/assign_to_user
Este método te permite asignar un cliente a un empleado. El parámetro email es opcional. Si no se proporciona ningún correo electrónico, el sistema asignará el cliente según su algoritmo.
Permiso de acceso al generar una clave: "Permiso para modificar/eliminar la información del cliente".
Ruta
api key* - token de acceso
Cuerpo
client_id - ID del cliente email - correo electrónico del empleado (opcional)
Importar clientes al sistema
POST https://chatter.mavibot.ai/api/#{api_key}/load_clients
URL de solicitud: https://chatter.mavibot.pro/api/#{api_key}/load_clients
Este método te permite importar clientes al sistema. Al cargar clientes de WhatsApp, puedes proporcionar el número en cualquier formato, con el final @s.whatsapp.net o sin él.
El ID del grupo (group_id) se puede obtener AQUÍ a través de /api/<api_key>/connected_channels. (Si client_type = 13 (telefonía), entonces group_id es una cadena vacía: ""). ссылка
El tipo de mensajero del que provino el cliente (client_type) se puede encontrar AQUÍ. ссылка
Ejemplo: [{"platform_id":"79875555555","group_id":34810,"client_type":6}]
Permiso de acceso al generar una clave: "Permiso para modificar o eliminar la información del cliente".
Ruta
api key* - token de acceso
Cuerpo
platform_id - número de teléfono group_id - ID del grupo client_type - el tipo de mensajero del que provino un cliente
Añadir clientes a una lista
POST https://chatter.mavibot.ai/api/<api_key>/add_to_list
URL de solicitud: https://chatter.mavibot.ai/api/<api_key>/add_to_list
Añade clientes a una lista
Permiso de acceso al generar una clave: "Permiso para modificar o eliminar la información del cliente".
Ruta
api key* - token de acceso
Cuerpo
list_id - número de lista clients - array de IDs de clientes
Ejemplo: Parámetros JSON {"list_id":1170282, "clients":[411262772, 646410963]}
Eliminar clientes de una lista
POST https://chatter.mavibot.ai/api/#{api_key}/remove_from_list
URL de solicitud: https://chatter.mavibot.ai/api/#{api_key}/remove_from_list
Elimina clientes de una lista
Permiso de acceso al generar una clave: "Permiso para modificar o eliminar la información del cliente".
Ruta
api key* - token de acceso
Cuerpo
list_id - número de lista clients - array de números de clientes en el generador Mavibot (valores de client_id)
Obtener la lista de clientes
GET https://chatter.mavibot.ai/api/<api_key>/get_clients
URL de solicitud: https://chatter.mavibot.a/aipi/<api_key>/get_clients
Permiso de acceso al generar una clave: "Permiso para modificar o eliminar la información del cliente".
Ruta
api key* - token de acceso
Cuerpo
offset – Desplazamiento desde el primer elemento
limit – Número de elementos en la respuesta / Predeterminado: 500, Máximo: 500
list – Número de lista
reverse – Indica ordenación inversa (del registro más antiguo al más nuevo). Este parámetro solo funciona si no se especifica la lista.
Devuelve el estado y un array de elementos.
Obtener la lista de suscriptores del bot en cualquier mensajero
GET https://chatter.mavibot.ai/api/#{api_key}/subscribers
URL de solicitud: https://chatter.mavibot.ai/api/#{api_key}/subscribers
Recupera información del cliente de un mensajero seleccionado.
¡Nota! Este método no devuelve variables.
Permiso de acceso al generar una clave: "Permiso para modificar o eliminar la información del cliente".
Ruta
api key* - token de acceso
Cuerpo
page tag – Etiqueta especificada en la página de suscripción group – ID del grupo VK al que está vinculado el suscriptor date_from – Suscrito después de esta fecha (timestamp) date_to – Suscrito antes de esta fecha (timestamp) client_type – ID del mensajero del que recuperar la lista de suscriptores. Si no se especifica, se devolverán todos los clientes
Cómo trabajar con variables
Asignar variables
POST https://chatter.mavibot.ai/api/#{api_key}/save_variables
URL de solicitud: https://chatter.mavibot.ai/api/#{api_key}/save_variables
! No se aplica ningún límite a esta solicitud.
Permite guardar variables tanto en el lead como en el cliente. Por defecto, la solicitud de asignación de variables las agrega a las variables del trato. Para actualizar las variables en el perfil del cliente, usa el prefijo client. Por ejemplo, para un teléfono: client.phone.
Permiso de acceso al generar una clave: "Permiso para modificar o eliminar la información del cliente".
Actualizar: El parámetro clients permite asignar variables de forma masiva. Ejemplo: {"client_id":49177759, "variables":{"client.phone":"88888888888"}}
Ruta
api key* - token de acceso
Cuerpo
clients – Array de IDs de clientes para la asignación de variables
client_id – ID del cliente
variables – Hash de variables (pares clave-valor)
Recuperar variables
GET https://chatter.mavibot.ai/api/#{api_key}/get_variables?client_id=
URL de solicitud: https://chatter.mavibot.ai/api/#{api_key}/get_variables?client_id=
Permiso de acceso al generar una clave: "Permiso para modificar o eliminar la información del cliente".
Ejemplo: https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/get_variables?client_id=49177759
Ruta
api key* - token de acceso
Cuerpo
client_id - ID del cliente
Cómo recuperar el ID del cliente (client_id)
Recuperar client_id usando el valor platform_id
POST https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_platform_id
URL de solicitud: https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_platform_id
Permiso de acceso al generar una clave: "Permiso para modificar o eliminar la información del cliente".
Ruta
api key* - token de acceso
Cuerpo
platform_ids - array de IDs en un mensajero group_id - ID del bot
Recuperar el ID del cliente del chat en línea
GET https://chatter.mavibot.ai/api/#{api_key}/online_chat_client_id?recipient=
URL de solicitud: https://chatter.mavibot.ai/api/#{api_key}/online_chat_client_id?recipient=
Este método te permite integrar un sitio web con un chatbot. Por ejemplo, si un usuario visita una página de promoción, puedes enviar inmediatamente un mensaje en el chat con una oferta personalizada.
Permiso de acceso al generar una clave: "Permiso para modificar o eliminar la información del cliente".
Ruta
api key* - tique de acceso
Cuerpo
tag - etiqueta (etiqueta del cliente) name - nombre del cliente recipient - ID del diálogo en un sitio web
Dónde obtener el recipient?
Puedes obtenerlo en el sitio web con el chat en línea de Mavibot.ai, usa JS para obtener la propiedad MavibotAi.recipient_id.
Recuperar client_id por número de WhatsApp
GET https://chatter.mavibot.ai/api/#{api_key}/whatsapp_client_id?phone=
URL de solicitud: https://chatter.mavibot.ai/api/#{api_key}/whatsapp_client_id?phone=
Este método devuelve el ID del cliente para realizar solicitudes API si conoces el número de WhatsApp del cliente. Si no existe ningún cliente con ese número, el método devolverá un error 404.
Permiso de acceso al generar una clave: "Permiso para modificar o eliminar la información del cliente".
Ruta
api key* - token de acceso
Cuerpo
phone - número de teléfono group_id - ID del bot
Recuperar client_id por número de teléfono
GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_phone?phone=
URL de solicitud: https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_phone?phone=
Este método devuelve el ID del cliente para realizar solicitudes API.
La búsqueda se realiza tanto entre clientes de WhatsApp como mediante variables.
Permiso de acceso al generar una clave: "Permiso para modificar o eliminar la información del cliente".
Ruta
api key* - token de acceso
Cuerpo
phone - número de teléfono
Obtener client_id por correo electrónico
GET https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_email?email=
Solicitud URL: https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_email?email=
Este método devuelve el ID del cliente para realizar solicitudes a la API. La búsqueda se realiza usando variables.
Permiso de acceso al generar una clave: "Permiso para modificar o eliminar la información del cliente".
Ruta
api key* - token de acceso
Cuerpo
email - correo electrónico para la búsqueda
Obtener client_id por valor de variable
GET https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_var?var=&val=
Solicitud URL: https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_var?var=&val=
Este método devuelve el ID del cliente para realizar solicitudes API.
Permiso de acceso al generar la clave: "Permiso para leer la información del cliente"
Ruta
api key* - token de acceso
Cuerpo
var - nombre de la variable por la que buscar val - valor de la variable group_id - ID del grupo search_in - pasa el valor 'order' para buscar en variables de negocio; busca hasta tres variables para clientes de proyectos y devuelve una lista de clientes que tienen todas las variables especificadas.
Obtener el ID del cliente creado más recientemente por valor de variable
GET https://chatter.mavibot.ai/api/#{api_key}/find_latest_client_id_by_var?var=&val=
Solicitud URL: https://chatter.mavibot.ai/api/#{api_key}/find_latest_client_id_by_var ?var=&val=
Este método devuelve el ID del cliente creado más recientemente para realizar solicitudes a la API. Busca tanto en variables del cliente como del negocio.
Permiso de acceso al generar la clave: "Permiso para leer la información del cliente"
Ruta
api key* - token de acceso
Cuerpo
var - nombre de la variable por la que buscar val - valor de la variable
Obtener una lista de valores client_id por valor de variable
GET https://chatter.mavibot.ai/api/#{api_key}/find_all_client_id_by_var?var=&val=
Solicitud URL: https://chatter.mavibot.ai/api/#{api_key}/find_all_client_id_by_var?var=&val=
Este método devuelve una lista de IDs de cliente que tienen la variable especificada con el valor especificado.
Permiso de acceso al generar la clave: "Permiso para leer la información del cliente"
Ruta
api key* - token de acceso
Cuerpo
var - nombre de la variable por la que buscar val - valor de la variable
Obtener una lista de valores client_id basados en múltiples valores de variables
GET https://chatter.mavibot.ai/api/#{api_key}/find_all_client_id_by_several_vars?var=val
Solicitud URL: https://chatter.mavibot.ai/api/#{api_key}/find_all_client_id_by_several_vars?var=val
Permiso de acceso al generar la clave: "Permiso para leer la información del cliente".
Ruta
api key* - token de acceso
Cuerpo
variable1 - Valor1
variable2 - Valor2
variable3 - Valor3
Buscar por variables
POST https://chatter.mavibot.ai/api/#{api_key}/find_clients
Solicitud URL: https://chatter.mavibot.ai/api/#{api_key}/find_clients
Este método busca por variables y devuelve una lista de IDs de cliente que cumplen las condiciones de la consulta.
De forma predeterminada, la búsqueda se realiza en variables del cliente (recomendado): {"q": {"result": "ok", "var": "home", "var": "60"}} – el cliente debe tener todas las variables especificadas
Buscar en variables de negocio; debe estar presente al menos una de las variables especificadas: {"q": {"result": "ok", "var": "home", "var": "60"}, "search_in": "order", "include_all": False}
El nombre de la variable del cliente es igual a uno de los valores de la lista: {"q": {"name": {"_in": ["Joe", "Jane", "Donald"]}}}
El nombre de la variable del cliente NO es igual a ninguno de los valores de la lista: {"q": {"name": {"_not_in": ["Joe", "Jane", "Donald"]}}}
El nombre de la variable del cliente no es igual a "Joe": {"q": {"name": {"_not": "Joe"}}}
Nota: La comparación numérica solo funciona si todos los clientes tienen valores numéricos en la variable buscada. Si incluso un cliente tiene una cadena, la solicitud fallará.
Permiso de acceso al generar la clave: "Permiso para leer la información del cliente"
Parámetros
Ruta
api key* - token de acceso
Cuerpo
q – parámetro obligatorio, contiene las condiciones de la consulta para buscar variables
search_in – especifica en las variables de qué entidad buscar; si no se proporciona, la búsqueda se realiza en las variables del cliente. Puede tomar el valor order.
include_all – indica si todas las condiciones de q deben cumplirse;
False – si coincide al menos una condición, se selecciona la entidad
Cómo trabajar con negocios
Obtener el ID del negocio actual
GET https://chatter.mavibot.ai/api/#{api_key}/get_current_order_id
URL de solicitud: https://chatter.mavibot.ai/api/#{api_key}/get_current_order_id
Permiso de acceso al generar la clave: "Permiso para leer la información del CRM".
Ruta
api key* - token de acceso
Cuerpo
client_id - ID del cliente
Obtener la lista de negocios
GET https://chatter.mavibot.ai/api/#{api_key}/get_orders
URL de solicitud: https://chatter.mavibot.ai/api/#{api_key}/get_orders
Permiso de acceso al generar la clave: "Permiso para leer la información del CRM"
Ruta
api key* - token de acceso
Cuerpo
client_id - ID del cliente
order_status - etapa del negocio: 0 - negocios activos 1 - negocios exitosos 2 - negocios no exitosos
Mover un negocio a la siguiente etapa en el embudo de Mavibot
POST https://chatter.mavibot.ai/api/#{api_key}/move_order_to_next_state
URL de solicitud: https://chatter.mavibot.ai/api/#{api_key}/move_order_to_next_state
Permiso de acceso al generar la clave: "Permiso para modificar/eliminar información del CRM"
Ruta
api key* - token de acceso
Cuerpo
client_id - ID del cliente
order_id - ID del negocio
Obtener datos del negocio
POST https://chatter.mavibot.ai/api/#{api_key}/get_order_vars
URL de solicitud: https://chatter.mavibot.ai/api/#{api_key}/get_order_vars
Permiso de acceso al generar la clave: "Permiso para leer la información del CRM"
Ruta
api key* - token de acceso
Cuerpo
client_id - ID del cliente
order_id - ID del negocio
variables - matriz de variables (formato:["var_name1", "var_name2"])
Añadir variables del negocio
POST https://chatter.mavibot.ai/api/#{api_key}/set_order_vars
URL de solicitud: https://chatter.mavibot.ai/api/#{api_key}/set_order_vars
Permiso de acceso al generar la clave: "Permiso para modificar/eliminar información del CRM"
Ruta
api key* - token de acceso
Cuerpo
client_id - ID del cliente
order_id - ID del negocio
variables - Un diccionario de variables (la clave es el nombre de la variable y el valor es lo que debe guardarse en esa variable) (formato:{"var_name": "var_velue"})
Crear un negocio
POST https://chatter.mavibot.ai/api/#{api_key}/create_order
URL de solicitud: https://chatter.mavibot.ai/api/#{api_key}/create_order
Permiso de acceso al generar la clave: "Permiso para modificar/eliminar información del CRM"
Ruta
api key* - token de acceso
Cuerpo
client_id - ID del cliente
name - nombre del negocio
description - descripción del negocio
budget - monto del negocio
Debe especificar uno de los siguientes parámetros en la solicitud: client_id, email o phone. Si se proporcionan varios parámetros, solo se usará uno. El orden de prioridad es: client_id > phone > email. Si se proporciona phone o email y no existe ningún cliente con ese número de teléfono o correo electrónico, se creará un nuevo cliente.
Mover un negocio a una etapa en MavibotCRM
POST https://chatter.mavibot.ai/api/#{api_key}/set_order_state
URL de solicitud: https://chatter.mavibot.ai/api/#{api_key}/set_order_state
Permiso de acceso al generar la clave: "Permiso para modificar/eliminar información del CRM"
Ruta
api key* - token de acceso
Cuerpo
client_id - ID del cliente
state_id - el número de etapa al que debe moverse el negocio del cliente
Obtener el ID de la etapa del embudo en Mavibot CRM
GET https://chatter.mavibot.ai/api/#{api_key}/get_order_state
URL de solicitud: https://chatter.mavibot.ai/api/#{api_key}/get_order_state
Permiso de acceso al generar la clave: "Permiso para leer la información del CRM"
Ruta
api key* - token de acceso
Cuerpo
client_id - ID del cliente
state_id - ID del negocio (si no se especifica, el método devolverá el ID de la etapa del negocio actual)
¿Qué otras capacidades están disponibles?
Verificar si un número de teléfono tiene WhatsApp
GET https://chatter.mavibot.ai/api/#{api_key}/check_whatsapp
URL de solicitud: https://chatter.mavibot.ai/api/#{api_key}/check_whatsapp
Para usar este método, WhatsApp debe estar conectado a Mavibot.
Permiso de acceso al generar una clave: "Permiso para modificar o eliminar la información del cliente".
Se puede llamar usando GET o POST. El número de teléfono puede proporcionarse en cualquier formato.
Ruta
api key* - token de acceso
Cuerpo
phone - número de teléfono a verificar
Obtener la lista de mensajeros conectados al proyecto
GET https://chatter.mavibot.ai/api/<api_key>/connected_channels
Solicitud URL: https://chatter.mavibot.ai/api/<api_key>/connected_channels
Permiso de acceso al generar una clave: "Permiso para modificar o eliminar la información del cliente".
La función devuelve el parámetro group_id para cada mensajero, que debe usarse al importar clientes.
Para WhatsApp, también devuelve un status campo, que puede tener los siguientes valores:
NOT_STARTED = 0 STARTED = 1 ASLEEP = 2 STOPPED = 3
Ruta
api key* - token de acceso
Obtener la lista de bloques del flujo del bot
GET https://chatter.mavibot.ai/api/<api_key>/get_messages
URL de solicitud: https://chatter.mavibot.ai/api/<api_key>/get_messages
Permiso de acceso al generar una clave: "Permiso para modificar o eliminar la información del cliente".
Ruta
api key* - token de acceso
Obtener datos anidados del cliente
delimiter
Para obtener client_id y/o el número de teléfono del cliente a partir de diccionarios anidados (no en el primer nivel), use el parámetro delimiter.
Añada lo siguiente a la URL de su solicitud:
?delimiter=1&delimiter_value_client_id={key1}1{key2}&delimiter_value_phone={key1}1{key2}
donde:
?delimiter=1 – el valor del delimitador que separa las claves {key1}1{key2}1{key3}
delimiter_value_client_id={key1}1{key2} – para obtener el ID del cliente
delimiter_value_phone={key1}1{key2} – para obtener el número de teléfono del cliente
{key1}, {key2}, … – claves que contienen los valores (pueden incluir cualquier carácter excepto el delimitador). Puede tener un número ilimitado de claves: ?delimiter=1&delimiter_value_client_id={key1}1{key2}1{key3}1{key4}1{key5}1{key6}. Las claves se pasan sin llaves.
Use el delimitador entre las claves. Por ejemplo, si delimiter=2, entonces {key1}2{key2}2{key3}; si delimiter=5, entonces {key1}5{key2}5{key3}. Asegúrese de que la clave no contenga el carácter delimitador.
Ejemplo:
https://chatter.mavibot.a/aipi/<api_key>/callback?delimiter=1&delimiter_value_client_id={key1}1{key2}&delimiter_value_phone={key1}1{key2}
También puede obtener solo el ID o solo el número de teléfono:
https://chatter.salebot.pro/api/<api_key>/callback?delimiter=1&delimiter_value_client_id={key1}1{key2} - solo ID del cliente;
https://chatter.salebot.pro/api/<api_key>/callback?delimiter=1delimiter_value_phone={key1}1{key2} - solo número de teléfono;
Métodos de la API:
Iniciar bot: https://chatter.mavibotbot.ai/api/<api_key>/callback
Iniciar bot por número de WhatsApp: https://chatter.mavibotbot.ai/api/<api_key>/whatsapp_callback
Iniciar bot por ID de Telegram: https://chatter.mavibotbot.ai/api/<api_key>/tg_callback
Enviar mensaje de callback al cliente por correo electrónico: https://chatter.mavibotbot.ai/api/<api_key>/email_callback
Enviar mensaje al cliente: https://chatter.mavibotbot.ai/api/<api_key>/message
Enviar mensaje de WhatsApp: https://chatter.mavibotbot.ai/api/<api_key>/whatsapp_message
Mensajería masiva: https://chatter.mavibotbot.ai/api/<api_key>/broadcast
Asignar variables: https://chatter.mavibotbot.ai/api/<api_key>/save_variables
Si necesita métodos adicionales, póngase en contacto con el soporte.
Última actualización