La API del software de edición

Qué solicitudes admite el software de edición y cómo realizarlas

Las solicitudes se realizan con el método POST en la URL, es decir https://chatter.mavibot.ai/api/{api_key}/{action}

Dónde se encuentra: api_key es la clave para acceder a la API que se obtiene en la configuración del proyecto:

circle-check
triangle-exclamation
circle-exclamation

Cómo obtener mensajes en la URL de Webhook especificada en la configuración del proyecto

La configuración del proyecto

Cada mensaje entrante o saliente viene con las siguientes solicitudes POST en json:

Si la solicitud devolvió un error, no se reenviará. Si el servidor devolvió un error, las notificaciones llegarán a pesar de ello.

Cómo usar un webhook universal

Estos métodos ahora se pueden lanzar tanto con la solicitud POST como con la GET.

Anteriormente, los parámetros (con los que se lanzaban los métodos de los clientes, es decir client_id) estaban escritos de forma muy estricta en nuestros métodos y eso imponía algunas restricciones al usarlos con servicios de terceros.

Ahora puedes indicar en qué parámetro de la solicitud buscará Mavibot el identificador del usuario: para ello, se usa un parámetro con el prefijo value_ como value_user_id y value_group_id.

Además, el método para enviar el callback callback puede iniciarse transmitiendo un correo electrónico (client_email) y un número de teléfono del cliente (client_phone).

circle-check

Es útil cuando configuras la recepción del webhook a través de otro sitio.

Para especificar qué variable contiene client_id debes transferir value_client_id y mencionar el nombre del parámetro que contiene este valor

Para especificar qué variable contiene phone debes transferir value_phone y mencionar el nombre del parámetro que contiene este valor

Para especificar qué variable contiene email debes transferir value_email y mencionar el nombre del parámetro que contiene este valor

Para especificar qué variable contiene user_id debes transferir value_user_id y mencionar el nombre del parámetro que contiene este valor

Para especificar qué variable contiene group_id debes transferir value_group_id y mencionar el nombre del parámetro que contiene este valor

Ejemplo:

Escribe en la dirección value_client_id = my_client

https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback?value_client_id=my_client {"my_client":49177759, "message":"Hello world"}

La consulta será equivalente a la siguiente consulta:

https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback {"client_id":49177759, "message":"Hola mundo"}

circle-info

Como puedes ver, el nombre del parámetro que contiene el nombre se diferencia por el prefijo value_

Cómo iniciar el bot

El inicio del bot

POST https://chatter.mavibot.ai/api/<api_key>/callback

El método puede usarse para iniciar el flujo de trabajo del cliente o para aprobar la acción en un servicio de terceros. Este mensaje no será visible para el cliente. Además, los parámetros transferidos se guardan en las variables. El método para enviar el callback ahora puede activarse compartiendo un correo electrónico (client_email) o el número de teléfono del cliente (client_phone)

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

token de acceso

Cuerpo de la solicitud

Name
Tipo
Descripción

client_phone

de cadena

número de teléfono mediante el cual se encuentra al cliente

client_email

de cadena

correo electrónico mediante el cual se encuentra al cliente

client_id

de cadena

id del cliente en el editor

message

de cadena

el texto del mensaje

Inicio del bot a través del número en WhatsApp

POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_callback

Este método inicia el bot en WhatsApp después de que el cliente se registre a través del sitio o después de que deje una solicitud con su número de teléfono Además, los parámetros transferidos se guardan en las variables

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

token de acceso

Cuerpo de la solicitud

Name
Tipo
Descripción

name

de cadena

el nombre del cliente

message

de cadena

el texto del mensaje

phone

de cadena

el número de teléfono del cliente

bot_id

de cadena

el id del bot

Inicio del bot a través del id de Telegram

POST https://chatter.mavibot.ai/api/<api_key>/tg_callback

El método puede usarse para iniciar el flujo de trabajo o confirmar acciones en un sitio de terceros. Este mensaje no será visible para el cliente.

Además, los parámetros transferidos se guardan en las variables

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

token de acceso

Cuerpo de la solicitud

Name
Tipo
Descripción

message

de cadena

el texto del mensaje

user_id

de cadena

el id del usuario en Telegram

group_id

de cadena

el nombre del bot (debe terminar en bot)

Cómo trabajar con mensajes

Parámetros para enviar mensajes

attachment_type puede tomar estos valores: imagen, video, enlace, archivo, audio Al enviar archivos adjuntos, el parámetro message no es obligatorio

buttons identifica los botones que se adjuntarán al mensaje. El formato de los botones es comparable a la configuración avanzada de botones. Son posibles dos variantes de transmisión de los botones: una con la sugerencia en mensajeros sin botones y otra sin ella

Aquí tienes un ejemplo del parámetro buttons:

Envío del mensaje al cliente

POST https://chatter.mavibot.ai/api/<api_key>/message

Este método puede usarse para enviar mensajes con notificaciones. El parámetro message es obligatorio si no estás enviando un archivo. Si lo haces, entonces el texto no es necesario

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

la clave de acceso

Cuerpo de la solicitud

Name
Tipo
Descripción

message_id

de cadena

el número del bloque de envío

message

de cadena

el texto del mensaje

client_id

de cadena

el id del cliente en el editor

attachment_type

de cadena

el tipo de visualización del archivo

attachment_url

de cadena

la URL del archivo

buttons

objeto

buttons

Envío de mensajes en WhatsApp

POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_message

Permite enviar un mensaje en nombre del bot conectado al número mencionado whatsapp_bot_id debe tomarse de la sección “Mensajeros y chats”. Cada página de WhatsApp conectada obtiene una identificación única

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

la clave de acceso

Cuerpo de la solicitud

Name
Tipo
Descripción

message_id

de cadena

el número del bloque de envío

whatsapp_bot_id

número

el bot de WhatsApp que envía el mensaje

attachment_url

de cadena

la url del archivo

attachment_type

de cadena

el tipo de visualización del archivo

message

de cadena

el texto del mensaje

phone

de cadena

el número de teléfono del destinatario

Envío de mensajes en masa

POST https://chatter.mavibot.ai/api/<api_key>/broadcast

El método permite la distribución de mensajes. Si el parámetro clients no se menciona, la difusión se enviará a todos los usuarios. Es necesario enviar un archivo o un texto

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

la clave de acceso

Cuerpo de la solicitud

Name
Tipo
Descripción

message_id

de cadena

el número del bloque de envío

list

de cadena

la lista de números de destinatarios

shift

de cadena

la cantidad de segundos entre mensajes. 0.2 por defecto

message

de cadena

el texto del mensaje

clients

arreglo

los ids de los destinatarios

attachment_type

de cadena

el tipo de visualización del archivo

attachment_url

de cadena

la URL del archivo

buttons

de cadena

buttons

Obtención del historial de mensajes

GET https://chatter.mavibot.ai/api/<api_key>/get_history?client_id=

Obtener el historial de mensajes. Puedes obtener el client_id parámetro AQUÍ

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

la clave de acceso

Parámetros de consulta

Name
Tipo
Descripción

client_id

de cadena

el id del cliente

Borrado del historial de mensajes

GET https://chatter.mavibot.ai/api/<api_key>/clear_history?client_id=

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

la clave de acceso

Parámetros de consulta

Name
Tipo
Descripción

client_id

de cadena

el id del cliente

Cómo distribuir los clientes

Asignar un cliente a un empleado

GET https://chatter.mavibot.ai/api/<api_key>/assign_to_user

El método permite asignar un cliente a un empleado. El parámetro de correo electrónico es opcional. Si no se proporciona el correo electrónico, se distribuirá mediante el algoritmo del sistema

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

la clave de acceso

Parámetros de consulta

Name
Tipo
Descripción

client_id

Cadena

el id del cliente

correo electrónico

Cadena

el correo electrónico del trabajador (opcional)

Carga de clientes en el sistema

GET https://chatter.mavibot.ai/api/<api_key>/load_clients

El método permite cargar clientes en el sistema. Al subir clientes de WhatsApp puedes transferir el número libremente con @s.whatsapp.net al final o sin él.

Puedes obtener el id del grupo (group_id) aquí a través de /api/<api_key>/connected_channels

(si client_type=13 (telefonía) entonces group_id=””)

Puedes ver el tipo de mensajero del que vino el cliente (client_type)

Ej.: [{"platform_id":"79875555555","group_id":34810,"client_type":6}]

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

la clave de acceso

Cuerpo de la solicitud

Name
Tipo
Descripción

platform_id

Cadena

el número de teléfono

group_id

Cadena

el id del grupo

client_type

Cadena

el tipo de mensajero del que vino el cliente

Añadir clientes a la lista

POST https://chatter.mavibot.ai/api/<api_key>/add_to_list

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

la clave de acceso

Cuerpo de la solicitud

Name
Tipo
Descripción

list_id

entero

el número de la lista

clients

arreglo

el arreglo de números de los clientes

Eliminar clientes de la lista

POST https://chatter.mavibot.ai/api/<api_key>/remove_from_list

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

la clave de acceso

Cuerpo de la solicitud

Name
Tipo
Descripción

list_id

entero

el número de la lista

clients

arreglo

el arreglo de números de los clientes

Obtener la lista de clientes

POST https://chatter.mavibot.ai/api/<api_key>/get_clients

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

la clave de acceso

Parámetros de consulta

Name
Tipo
Descripción

offset

de cadena

desplazamiento desde el primer elemento

limit

entero

la cantidad de elementos en la respuesta. 500 por defecto, máx. 500

list

de cadena

el número de la lista

Obtener la lista de suscriptores en cualquier mensajero

POST https://chatter.mavibot.ai/api/<api_key>/subscribers

Obtener la información sobre los clientes en el mensajero elegido

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

la clave de acceso

Parámetros de consulta

Name
Tipo
Descripción

page

entero

tag

de cadena

la etiqueta mencionada en la página de suscripción

group

entero

el id del grupo al que está vinculado el suscriptor

date_from

entero

marca de tiempo de la fecha después de que se suscribieron

date_to

entero

marca de tiempo de la fecha hasta la que se suscribieron

client_type

entero

el id del mensajero al que necesitas suscribir la lista. si no cambias nada aparecen todos los clientes

Permiso para eliminar clientes

POST https://chatter.mavibot.ai/api/<api_key>/get_clients

Permiso de acceso al generar la clave: “Permiso para eliminar clientes”

Parámetros

Ruta api key* — token de acceso

Cuerpo client_ids — lista de IDs de clientes que se eliminarán. Máximo 500. Ejemplo: [199571, 199707, 1935722]

Cómo trabajar con variables

Atribución de variables

POST https://chatter.mavibot.ai/api/<api_key>/save_variables

Permite guardar variables en la aplicación y en el cliente. La solicitud de atribución de variables, por defecto, añade a las variables de transacción. Si necesitas cambiar las variables en el perfil, debes añadir el prefijo client. Ej. para móvil: client.phone

El parámetro clients permite atribuir variables en masa

Ej.: {"client_id":49177759, "variables": {"client.phone":"1234567890"}}

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

la clave de acceso

Cuerpo de la solicitud

Name
Tipo
Descripción

clients

arreglo

arreglo de id de clientes para asignar variables

client_id

de cadena

id del cliente

variables

objeto

hash de variables (clave valor)

Obtención de variables

GET https://chatter.mavibot.ai/api/<api_key>/get_variables?client_id=

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

token de acceso

Parámetros de consulta

Name
Tipo
Descripción

client_id

de cadena

id del cliente

Cómo obtener client_id

Obtener client_id por el valor platform_id

POST https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_platform_id

El método devuelve el id del cliente para ejecutar solicitudes a la API

Ejemplo de parámetros: {"platform_ids": ["571830542", "256865200"]}

Parámetros de ruta

Name
Tipo
Descripción

de cadena

clave de acceso

Cuerpo de la solicitud

Name
Tipo
Descripción

platform_ids

de cadena

arreglo de ids en el mensajero

Cómo obtener el id del cliente en Online chat

GET https://chatter.mavibot.ai/api/<api_key>/online_chat_client_id?recipient=

Este método permite integrar el sitio y el chatbot, es decir, si una persona fue a la página con la oferta especial, puedes enviar de inmediato un mensaje sobre la oferta en el chat

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

token de acceso

Parámetros de consulta

Name
Tipo
Descripción

tag

de cadena

etiqueta del cliente

name

de cadena

el nombre del cliente

recipient

de cadena

el id del diálogo en el sitio

¿Dónde obtienes el recipient? En el sitio que ejecuta el chat en línea “Mavibot.ai” necesitas obtener la propiedad SaleBotPro.recipient_id con ayuda de JS.

Cómo obtener el id del cliente con el número de WhatsApp

GET https://chatter.mavibot.ai/api/<api_key>/whatsapp_client_id?phone=

El método devuelve el id del cliente para ejecutar solicitudes a la API si conoces el número de teléfono del cliente en WhatsApp. Si no existe tal cliente con este número, obtendrás un 404.

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

token de acceso

Parámetros de consulta

Name
Tipo
Descripción

phone

de cadena

el número de teléfono

Obtención del id del cliente con el número de teléfono

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_phone?phone=

El método devuelve el id del cliente para ejecutar solicitudes a la API. La búsqueda se realiza a través de clientes de WhatsApp, así como a través de variables.

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

token de acceso

Parámetros de consulta

Name
Tipo
Descripción

phone

de cadena

el número de teléfono

Obtención del id del cliente por correo electrónico

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_email?email=

El método devuelve el id del cliente para ejecutar solicitudes a la API. La búsqueda se realiza a través de variables.

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

token de acceso

Parámetros de consulta

Name
Tipo
Descripción

correo electrónico

de cadena

correo electrónico para la búsqueda

Obtención del id del cliente por el valor de una variable

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_var?var=&val=

El método devuelve el id del cliente para ejecutar solicitudes a la API

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

token de acceso

Parámetros de consulta

Name
Tipo
Descripción

var

de cadena

el nombre de la variable a través de la cual se realizará la búsqueda

val

de cadena

el valor de la variable

Qué otras posibilidades hay

Mover la transacción al estado MavibotCRM

POST https://chatter.mavibot.ai/api/<api_key>/set_order_state

El número de transacción puede obtenerse en la ventana de edición del flujo de trabajo de MavibotCRM.

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

la clave de acceso

Cuerpo de la solicitud

Name
Tipo
Descripción

client_id

de cadena

id del cliente

state_id

de cadena

el número de estado al que transferir la transacción del cliente

Comprobar si la persona sigue la cuenta de Instagram

GET https://chatter.mavibot.ai/api/<api_key>/check_insta_subscription

Puede llamarse tanto con el método POST como con el método GET

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

la clave de acceso

Cuerpo de la solicitud

Name
Tipo
Descripción

user_name

de cadena

el nombre de usuario del cliente que quieres comprobar

login

de cadena

el usuario del bot que se está comprobando

Comprobar si el número de teléfono tiene WhatsApp

GET https://chatter.mavibot.ai/api/<api_key>/check_whatsapp

Para usar el método DEBES tener conectados WhatsApp y Mavibot

Puede llamarse tanto con el método POST como con el método GET El número de teléfono puede transferirse en cualquier formato

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

token de acceso

Cuerpo de la solicitud

Name
Tipo
Descripción

phone

de cadena

el número de teléfono

Obtener la lista de mensajeros conectados al proyecto (incluyendo group_id)

GET https://chatter.mavibot.ai/api/<api_key>/connected_channels

La función devuelve el parámetro group_id a cada mensajero y es el que debe transferirse al cargar los clientes

El campo status también devuelve para WhatsApp, y contiene un valor de: NOT_STARTED = 0 STARTED = 1 ASLEEP = 2 STOPPED = 3

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

token de acceso

Obtención de la lista de bloques del esquema del bot

GET https://chatter.mavibot.ai/api/<api_key>/get_messages

Parámetros de ruta

Name
Tipo
Descripción

api_key

de cadena

token de acceso

circle-check

Última actualización