- Cómo recibir mensajes en la URL de Webhook especificada en la configuración del proyecto
- Cómo usar un webhook universal
- Cómo iniciar el bot
- Cómo trabajar con mensajes
- Cómo distribuir los clientes
- Cómo trabajar con variables
- Cómo obtener client_id
- Qué otras posibilidades existen
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:

Puedes obtener la clave de acceso usando la variable #{api_key}. Contiene la clave generada relevante. No olvides generar una antes de usarla.
Al copiar la url de la consulta desde esta página, se inserta un espacio que debe eliminarse al llamarla
Un ejemplo de copia incorrecta del enlace: https://chatter.mavibot.ai/api/callback 
El espacio después de .pro es fácil de pasar por alto, pero si se deja en su lugar, la consulta no funcionará
Al enviar la solicitud con el método GET, no uses palabras prohibidas. Consulta la formación correcta de las solicitudes GET
Cómo recibir mensajes en la URL de Webhook especificada en la configuración del proyecto

Cada mensaje entrante o saliente viene acompañado de las siguientes solicitudes json POST:
{
'id': el identificador del mensaje en el sistema,
'client': {
'id': el identificador del cliente en el sistema,
'recepient': el identificador del cliente en el mensajero,
'client_type': el tipo de mensajero,
'name': el nombre del cliente,
'avatar': el avatar del cliente,
'created_at': la fecha de creación del cliente,
'tag': la clave de suscripción,
'group': el bot al que está vinculado el cliente,
},
'message': el texto del mensaje,
'attachments': el array de enlaces a archivos,
'message_id': el id del bloque desde el que se envió el mensaje,
'project_id': el id del proyecto,
'is_input': 1 si el mensaje es de un cliente, 0 si es del bot,
'delivered': 1 si el mensaje se envió correctamente, 0 si hubo un error,
'error_message': el mensaje que explica el error
}
Si la solicitud regresa con un error, no se reenviará. Si el servidor regresa con un error, las notificaciones se seguirán enviando a pesar de esto.
Cómo usar un webhook universal
Estos métodos ahora se pueden ejecutar tanto con la solicitud POST como con la GET.
Anteriormente, los parámetros (con los que se ejecutaban los métodos de los clientes, es decir, client_id) estaban escritos de forma muy estricta en nuestros métodos y esto implementaba algunas restricciones al usarlos con servicios de terceros.
Ahora puedes indicar en qué parámetro de la solicitud Mavibot buscará el identificador del usuario: para esto, 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 se puede ejecutar transmitiendo un correo electrónico (client_email) y un número de teléfono del cliente (client_phone).
Los métodos callback y whatsapp_callback no están vinculados a los nombres de los parámetros. Puedes especificar qué parámetro contendrá el número de teléfono, el correo electrónico y el id del cliente.
Es útil cuando estás configurando la recepción del webhook a través de otro sitio.
Para especificar qué variable contiene client_id necesitas transferir value_client_id y mencionar el nombre del parámetro con este valor
Para especificar qué variable contiene el teléfono necesitas transferir value_phone y mencionar el nombre del parámetro con este valor
Para especificar qué variable contiene el correo electrónico necesitas transferir value_email y mencionar el nombre del parámetro con este valor
Para especificar qué variable contiene user_id necesitas transferir value_user_id y mencionar el nombre del parámetro con este valor
Para especificar qué variable contiene group_id necesitas transferir value_group_id y mencionar el nombre del parámetro con 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 consulta siguiente:
https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback
{"client_id":49177759, "message":"Hello world"}
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 se puede usar para iniciar el flujo de trabajo para el cliente o para aprobar la acción en un servicio de terceros. Este mensaje no será visible para el cliente.
Los parámetros transferidos adicionalmente se guardan en las variables.
El método para enviar el callback ahora se puede activar compartiendo un correo electrónico (client_email) o el número de teléfono del cliente (client_phone)
Parámetros de ruta
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | token de acceso |
Cuerpo de la solicitud
| Nombre | Tipo | Descripción |
|---|---|---|
| client_phone | string | número de teléfono con el que se encuentra al cliente |
| client_email | string | correo electrónico con el que se encuentra al cliente |
| client_id | string | id del cliente en el editor |
| message | string | el texto del mensaje |
**200: OK **
import requests
import json
params = {"message": "some_text", "client_id": "25554"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/callback'
requests.post(url, json=params)
Iniciar el 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
Los parámetros transferidos adicionalmente se guardan en las variables
Parámetros de ruta
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | token de acceso |
Cuerpo de la solicitud
| Nombre | Tipo | Descripción |
|---|---|---|
| name | string | el nombre del cliente |
| message | string | el texto del mensaje |
| phone | string | el número de teléfono del cliente |
| bot_id | string | el id del bot |
**200: OK **
{
// Response
}
Inicio del bot a través del id de Telegram
POST https://chatter.mavibot.ai/api/<api_key>/tg_callback
El método se puede usar para iniciar el flujo de trabajo o confirmar acciones en un sitio de terceros. Este mensaje no será visible para el cliente.
Los parámetros transferidos adicionalmente se guardan en las variables
Parámetros de ruta
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | token de acceso |
Cuerpo de la solicitud
| Nombre | Tipo | Descripción |
|---|---|---|
| message | string | el texto del mensaje |
| user_id | string | el id del usuario en Telegram |
| group_id | string | el nombre del bot (debe terminar en bot) |
**200: OK **
{
// Response
}
Cómo trabajar con mensajes
Parámetros para enviar mensajes
attachment_type puede tomar estos valores: image, video, link, file, 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 los botones. Son posibles dos variantes de transmisión de los botones: una con la información sobre herramientas en mensajeros sin botones y otra sin ella
Aquí hay un ejemplo del parámetro buttons:
"buttons": {"hint": "Este texto se mostrará en Whatsapp",
"buttons": [
{"type": "reply",
"text": "Qué servicios podemos proporcionar",
"line": 0, "index_in_line": 0},
{"type": "reply",
"text": "Información de pago",
"line": 0,
"index_in_line": 1},
{"type": "reply",
"text": "Nuestra información de contacto",
"line": 1, "index_in_line": 0},
{"type": "reply",
"text": "Dejar una solicitud",
"line": 1, "index_in_line": 1}
]
}
Enviar el mensaje al cliente
POST https://chatter.mavibot.ai/api/<api_key>/message
Este método se puede usar para enviar mensajes con notificaciones. El parámetro message es obligatorio si no estás enviando un archivo. Si lo estás haciendo, entonces el texto no es necesario
Parámetros de ruta
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | la clave de acceso |
Cuerpo de la solicitud
| Nombre | Tipo | Descripción |
|---|---|---|
| message_id | string | el número del bloque de envío |
| message | string | el texto del mensaje |
| client_id | string | el id del cliente en el editor |
| attachment_type | string | el tipo de visualización del archivo |
| attachment_url | string | la URL del archivo |
| buttons | object | botones |
**200: OK **
import requests
import json
params = {"message": "some_text", "client_id": "25554"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/message'
requests.post(url, json=params)
Enviar mensajes en WhatsApp
POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_message
Permite enviar un mensaje desde el 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
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | la clave de acceso |
Cuerpo de la solicitud
| Nombre | Tipo | Descripción |
|---|---|---|
| message_id | string | el número del bloque de envío |
| whatsapp_bot_id | number | el bot de WhatsApp que envía el mensaje |
| attachment_url | string | la url del archivo |
| attachment_type | string | el tipo de visualización del archivo |
| message | string | el texto del mensaje |
| phone | string | el número de teléfono del destinatario |
**200: OK **
import requests
import json
params = {"message": "some_text", "phone": "79875146788"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/whatsapp_message'
requests.post(url, json=params)
Enviar 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 transmisión se enviará a todos los usuarios. Es necesario enviar un archivo o un texto
Parámetros de ruta
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | la clave de acceso |
Cuerpo de la solicitud
| Nombre | Tipo | Descripción |
|---|---|---|
| message_id | string | el número del bloque de envío |
| list | string | la lista de números de destinatarios |
| shift | string | la cantidad de segundos entre mensajes. 0.2 por defecto |
| message | string | el texto del mensaje |
| clients | array | los ids de los destinatarios |
| attachment_type | string | el tipo de visualización del archivo |
| attachment_url | string | la URL del archivo |
| buttons | string | botones |
**200: OK **
{import requests
import json
params = {"message": "some_text", "clients": ["5", "58", "110"]}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/broadcast'
requests.post(url, json=params)
Obtener el historial de mensajes
GET https://chatter.mavibot.ai/api/<api_key>/get_history?client_id=
Obtener el historial de mensajes. Puedes obtener el parámetro client_id AQUÍ
Parámetros de ruta
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | la clave de acceso |
Parámetros de consulta
| Nombre | Tipo | Descripción |
|---|---|---|
| client_id | string | el id del cliente |
**200: OK **
{
"status": "success",
"result": [
{
"id": 104500,
"answered": true,
"client_replica": false,
"message_id": 390,
"message_from_outside": 0,
"created_at": 1587895014,
"text": "CouCou",
"attachments": {
},
"delivered": true,
"error_message": "true"
},
]
}
Limpiar el historial de mensajes
GET https://chatter.mavibot.ai/api/<api_key>/clear_history?client_id=
Parámetros de ruta
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | la clave de acceso |
Parámetros de consulta
| Nombre | Tipo | Descripción |
|---|---|---|
| client_id | string | el id del cliente |
**200: OK **
import requests
import json
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/clear_history?client_id=85856'
requests.get(url)
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á a través del algoritmo del sistema
Parámetros de ruta
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | la clave de acceso |
Parámetros de consulta
| Nombre | Tipo | Descripción |
|---|---|---|
| client_id | String | el id del cliente |
| String | el correo electrónico del trabajador (opcional) |
**200: OK **
import requests
import json
params = {"message": "some_text", "clients": ["5", "58", "110"]}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/broadcast'
requests.post(url, json=params)
Cargar clientes en el sistema
GET https://chatter.mavibot.ai/api/<api_key>/load_clients
El método permite cargar clientes en el sistema. Al cargar 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 provino el cliente (client_type)
Ej.: [{"platform_id":"79875555555","group_id":34810,"client_type":6}]
Parámetros de ruta
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | la clave de acceso |
Cuerpo de la solicitud
| Nombre | Tipo | Descripción |
|---|---|---|
| platform_id | String | el número de teléfono |
| group_id | String | el id del grupo |
| client_type | String | el tipo de mensajero del que provino el cliente |
**200: OK **
import requests
import json
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/load_clients'
params = [{ "platform_id": 274827917, "group_id": 169166236, "client_type":0},
{"platform_id":"[email protected]", "group_id": "1hwF7lwEjv4SKYIGFhQnBw==", "client_type": 6}]
requests.post(url, json=params)
# en caso de éxito, la función devuelve a cada elemento su id y estado de adición
# ejemplo de respuesta
# {"status":"success","items":[{"platform_id":"[email protected]","group_id":"5kqchxwyvdvFZOsp80q2qw==","client_type":6,"status":"success","id":1469409}]}
Agregar clientes a la lista
POST https://chatter.mavibot.ai/api/<api_key>/add_to_list
Parámetros de ruta
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | la clave de acceso |
Cuerpo de la solicitud
| Nombre | Tipo | Descripción |
|---|---|---|
| list_id | integer | el número de la lista |
| clients | array | el array de números de clientes |
**200: OK **
{
// Response
}
Eliminar clientes de la lista
POST https://chatter.mavibot.ai/api/<api_key>/remove_from_list
Parámetros de ruta
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | la clave de acceso |
Cuerpo de la solicitud
| Nombre | Tipo | Descripción |
|---|---|---|
| list_id | integer | el número de la lista |
| clients | array | el array de números de clientes |
**200: OK **
{
// Response
}
Obtener la lista de clientes
POST https://chatter.mavibot.ai/api/<api_key>/get_clients
Parámetros de ruta
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | la clave de acceso |
Parámetros de consulta
| Nombre | Tipo | Descripción |
|---|---|---|
| offset | string | desplazamiento desde el primer elemento |
| limit | integer | la cantidad de elementos en la respuesta. 500 por defecto, máx. 500 |
| list | string | el número de la lista |
200: OK Devuelve el estado de los elementos y el array
{
"status":"success",
"clients":[{
"id":44483,
"platform_id":"146467928",
"client_type":0,
"name":null,
"avatar":null,
"message_id":null,
"project_id":1,
"created_at":1588248599,
"updated_at":1588248599,
"custom_answer":null,
"tag":null,
"group":"143414131",
"operator_start_dialog":null
}
]
}
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
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | la clave de acceso |
Parámetros de consulta
| Nombre | Tipo | Descripción |
|---|---|---|
| page | integer | |
| tag | string | la etiqueta que se mencionó en la página de suscripción |
| group | integer | el id del grupo al que está vinculado el suscriptor |
| date_from | integer | timestamp de la fecha posterior a la que se suscribieron |
| date_to | integer | timestamp de la fecha hasta la que se suscribieron |
| client_type | integer | el id del mensajero para el que necesitas la sublista. si no cambias nada, aparecen todos los clientes |
**200: OK **
[
{
"id": 44886,
"tag": null,
"created_at": 1609867984,
"name": "John Smith",
"tg_id": "146467928",
"group": "155824294",
"variables": null
},
{
"id": 44889,
"tag": null,
"created_at": 1609867984,
"name": "Jane Austen",
"tg_id": "1609867984",
"group": "155824294",
"variables": {
"utm_source": "some_value"
}
}
]
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 a eliminar. Máximo 500. Ejemplo: [199571, 199707, 1935722]
Cómo trabajar con variables
Atribuir 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 agrega a las variables de transacción.
Si necesitas cambiar las variables en el perfil, debes agregar 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
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | la clave de acceso |
Cuerpo de la solicitud
| Nombre | Tipo | Descripción |
|---|---|---|
| clients | array | array de ids de clientes para asignar variables |
| client_id | string | id del cliente |
| variables | object | hash de variables (clave valor) |
**200: OK **
import requests
import json
params = {"client_id": "25554", "variables": {"var_name": "var_value"}}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/save_variables'
requests.post(url, json=params)
Obtener variables
GET https://chatter.mavibot.ai/api/<api_key>/get_variables?client_id=
Parámetros de ruta
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | token de acceso |
Parámetros de consulta
| Nombre | Tipo | Descripción |
|---|---|---|
| client_id | string | id del cliente |
**200: OK **
import requests
import json
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/get_variables?client_id=85856'
requests.get(url)
Cómo obtener client_id
Obtener client_id por el valor de 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
| Nombre | Tipo | Descripción |
|---|---|---|
| string | clave de acceso |
Cuerpo de la solicitud
| Nombre | Tipo | Descripción |
|---|---|---|
| platform_ids | string | array de ids en el mensajero |
**200: OK **
[{
"id":15099119,
"tag":null,
"created_at":1618815253,
"name":"Oscar Wilde",
"avatar":"https:\\/\\/files.mavibot.pro\\/uploads\\/avatars\\/256865200.jpg",
"platform_id":"2568652",
"group":"Mavibotpro_bot",
"variables":{"tg_username":"@wildeo"}},
{"id":21087377,
"tag":null,
"created_at":1626275893,
"name":"Freddie Mercury",
"avatar":"https:\\/\\/files.mavibot.pro\\/uploads\\/avatars\\/571830542.jpg",
"platform_id":"571830542",
"group":"Mavibotpro_bot",
"variables":{"tg_username":"@freddieisqueen"}
}]
Cómo obtener el id del cliente en el chat en línea
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 entró en la página con la oferta especial, puedes enviar instantáneamente un mensaje sobre la oferta en el chat
Parámetros de ruta
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | token de acceso |
Parámetros de consulta
| Nombre | Tipo | Descripción |
|---|---|---|
| tag | string | etiqueta del cliente |
| name | string | el nombre del cliente |
| recipient | string | el id del diálogo en el sitio |
**200: OK **
{ "client_id": 36553 }
¿Dónde obtienes el recipient? En el sitio que lleva el chat en línea "Mavibot.ai" necesitas obtener la función MaviBotPro.recipient_id con la 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
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | token de acceso |
Parámetros de consulta
| Nombre | Tipo | Descripción |
|---|---|---|
| phone | string | el número de teléfono |
**200: OK **
{
// Response
}
Obtener el 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 los clientes de WhatsApp, así como a través de variables.
Parámetros de ruta
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | token de acceso |
Parámetros de consulta
| Nombre | Tipo | Descripción |
|---|---|---|
| phone | string | el número de teléfono |
**200: OK **
{
// Response
}
Obtener el id del cliente a través del 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
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | token de acceso |
Parámetros de consulta
| Nombre | Tipo | Descripción |
|---|---|---|
| string | correo electrónico para la búsqueda |
**200: OK **
{
// Response
}
Obtener el id del cliente por el valor de la 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
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | token de acceso |
Parámetros de consulta
| Nombre | Tipo | Descripción |
|---|---|---|
| var | string | el nombre de la variable por la que se realizará la búsqueda |
| val | string | el valor de la variable |
**200: OK **
{
// Response
}
Qué otras posibilidades existen
Mover la transacción al estado de MavibotCRM
POST https://chatter.mavibot.ai/api/<api_key>/set_order_state
El número de transacción se puede obtener en la ventana de edición del flujo de trabajo de MavibotCRM.
Parámetros de ruta
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | la clave de acceso |
Cuerpo de la solicitud
| Nombre | Tipo | Descripción |
|---|---|---|
| client_id | string | id del cliente |
| state_id | string | el número de estado al que transferir la transacción del cliente |
**200: OK **
{
// Response
}
Comprobar si la persona sigue la cuenta de Instagram
GET https://chatter.mavibot.ai/api/<api_key>/check_insta_subscription
Se puede llamar tanto con el método POST como con el método GET
Parámetros de ruta
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | la clave de acceso |
Cuerpo de la solicitud
| Nombre | Tipo | Descripción |
|---|---|---|
| user_name | string | el nombre de usuario del cliente que quieres comprobar |
| login | string | el inicio de sesión del bot que se está comprobando |
200: OK El campo is_follower es el que contiene la información sobre si la persona lo sigue o no
{
"username": "beyonce",
"account_id": "1463220603",
"avatar": "https://instagram.fhel6-1.fna.fbcdn.net/v/t51.2885-19/1060168..",
"real_name": "Beyonce",
"is_follower": true,
"status": 200
}
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
Se puede llamar tanto con el método POST como con el método GET
El número de teléfono se puede transferir en cualquier formato
Parámetros de ruta
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | token de acceso |
Cuerpo de la solicitud
| Nombre | Tipo | Descripción |
|---|---|---|
| phone | string | el número de teléfono |
**200: OK **
{
// Response
}
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 se devuelve para WhatsApp, y contiene un valor de:
NOT_STARTED = 0
STARTED = 1
ASLEEP = 2
STOPPED = 3
Parámetros de ruta
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | token de acceso |
**200: OK **
{'project_id': 1,
'viber': [{
'id': 14,
'uri': 'mavibotstage',
'name': 'mavibotstage',
'enabled': true,
'group_id': 11}],
'facebook': [],
'telegram': [{
'id': 23,
'short_name': 'bulls_vs_bears_bot',
'name': 'bulls_vs_bears_bot',
'enabled': true,
'group_id': 'bulls_vs_bears_bot'}],
'whatsapp': []
}
Obtener la lista de bloques del esquema del bot
GET https://chatter.mavibot.ai/api/<api_key>/get_messages
Parámetros de ruta
| Nombre | Tipo | Descripción |
|---|---|---|
| api_key | string | token de acceso |
**200: OK **
{
// Response
}
Si necesitas métodos adicionales, por favor contacta al soporte al cliente