Las funciones de la API están disponibles solo en los planes "Business" y "MaviBot AI".
API MaviBot
LEYENDA:\ ! -Parámetros obligatorios
Cómo enviar un callback
callback()
Solo puedes enviar un callback a OTRO cliente.
¡NO PUEDES enviar un callback a TI MISMO!
callback(client_id, callback_message)
Parámetros:
! client_id - identificador del cliente
! callback_message - texto del mensaje de callback
Un callback es un mensaje especial del sistema que el bot reconoce como un comando para activar una acción específica. Este mensaje es invisible para el usuario y solo se registra dentro del perfil del cliente para su procesamiento interno.
Enviemos un callback al cliente con client_id=73704021
A continuación, configuramos la respuesta a este callback en el bloque con la condición.
callback('73704021', 'callback TEST123')
callback(client_id, 'callback TEST123')
Cómo enviar un callback en Telegram
tg_callback()
tg_callback(platform_id , callback_message,group_id, business_connection_id)
Parámetros:
! platform_id - identificador del cliente en Telegram
! callback_message - texto del mensaje de callback
group_id - identificador del bot de Telegram
tg_business - para trabajar con clientes business, se pasa el valor "1".
Este es un ejemplo con los parámetros obligatorios:
Este es un ejemplo con los parámetros opcionales:
tg_callback('73704021', 'callback TEST123')
tg_callback(platform_id, 'callback TEST123', None, 1)
¿Cómo agregar una redirección del bot con una etiqueta en respuesta a un botón de callback?
tg_callback_url_open(callback_query_id, url)
Parámetros: \ ! callback_query_id - este id permite identificar a la persona que presionó el botón y mostrarle una notificación de Alerta,\ ! url - URL que especifica el bot y el parámetro (se ve así: t.me/your_bot?start=XXXX, en lugar de your_bot - nombre del bot)
Cómo enviar un mensaje al cliente
message() | platform_message() | whatsapp_message()
Para almacenar texto con saltos de línea en una variable, establece el valor de la siguiente manera:
text = "Texto de la primera línea" + "\n" + "Texto de la segunda línea" + "\n" +"Texto de la tercera línea"
message(client_id, text, message_id, timeout)
Parámetros:\ ! client_id - identificador del cliente\ ! text - texto del mensaje
message_id - el ID del bloque. Si dejas el campo de texto vacío (") y completas este parámetro, se enviará al cliente el texto del bloque especificado.
Nota: Si pasas el parámetro message_id a la función message, el bloque se ejecutará completamente de todos modos, y el cliente especificado en el parámetro client_id será movido al bloque que pasaste en message_id.
timeout - retraso del mensaje o tiempo de envío programado. Puedes usar el parámetro timeout para retrasar el envío del mensaje:
a) Un retraso en segundos (hasta 3600 segundos). Si el valor supera 3600, el mensaje se enviará en una hora. Si el valor es negativo, el mensaje se enviará inmediatamente. Ejemplo: timeout = 50
b) Una fecha y hora específica en el formato dd.mm.yyyy hh:mm, ejemplo: timeout = '03.04.2022 15:00'. Si se especifica una fecha pasada, el mensaje se enviará inmediatamente.
platform_message(platform_id, text, client_type, message_id, timeout,group_id)
Parámetros:\ ! platform_id - identificador del cliente en el mensajero\ ! text - texto del mensaje
client_type - tipo de mensajero, parámetro opcional. Si no se especifica, se buscará al cliente en el mismo mensajero desde el que el bot envía el mensaje. Si se especifica, se encontrará al cliente en la base de datos del mensajero indicado. Puedes encontrar los tipos de mensajero aquí.
message_id - ID del bloque. Si se especifica, el cliente recibirá el mensaje del bloque indicado, no el valor del parámetro text.
timeout - tiempo de envío o retraso. Es similar al parámetro de la función message() del mismo nombre.
group_id - identificador del bot
whatsapp_message(phone, text, message_id)
Parámetros:\ ! phone- el número de teléfono del cliente donde está registrado Whatsapp\ ! text - texto del mensaje
message_id - es el ID del bloque. Si el campo de texto se deja vacío ('') y se establece este parámetro, el cliente recibirá el contenido del mensaje del bloque especificado.
El bot de Whatsapp debe estar conectado al proyecto.
Un ejemplo simple de envío de un mensaje por client_id:
Diferentes opciones para enviar un mensaje por client_id:
Ejemplo de envío de un mensaje a través de platform_message():
/*Enviar un mensaje por client_id*/
message(73704021, 'Texto del mensaje para el cliente')
/*Enviar un mensaje por client_id con un retraso de 30 segundos*/
message(73704021, '¡Hola! Gracias por escribir..','',30)
/*Enviar un mensaje desde el bloque 3190 por client_id el 03.04.2022 a las 3pm*/
message(73704021, '',3190, '03.04.2022 3pm')
/*Enviar mensaje en Whatsapp*/
whatsapp_message('79999999999', 'Texto del mensaje para el cliente')
Obtener client_id por el valor de platform_id
get_client_id_by_platform_id()
get_client_id_by_platform_id(client_type, platform_id , group)
Después de ejecutarse, la función devolverá el client_id si se encuentra un cliente que coincida con las condiciones especificadas; de lo contrario, devolverá None.
! client_type - mensajero. Para el valor de client_type lee este artículo.
! platform_id - ID del cliente en el mensajero especificado.
group - es un parámetro obligatorio si hay más de un bot de mensajería conectado.
Si hay varios mensajeros del mismo tipo conectados en el proyecto, la búsqueda se realizará en todos los mensajeros conectados de este tipo.
En este caso, recomendamos pasar el parámetro group.
Función para solicitudes get: requests_get(url, answer_type, headers, params, auth, proxy)
! url - es un enlace donde se realiza la solicitud
answer_type – es un parámetro opcional que define qué debe devolverse de la respuesta del servidor: ('status' – devuelve el código de estado de la respuesta; 'json' – devuelve el cuerpo json de la respuesta; 'text' – devuelve el texto sin procesar de la respuesta; cualquier otro valor (incluido el predeterminado) devuelve una respuesta en el formato: '{"status": status_code, "data": data}')
headers - es un parámetro opcional para pasar encabezados de solicitud,
params - son los parámetros de la solicitud get (también se pueden incluir directamente en la URL),
auth - es un parámetro opcional útil para la autenticación de API. Si no deseas usar ningún parámetro opcional pero necesitas el siguiente, pasa 0 aquí.
proxy - es un parámetro opcional; acepta un valor: "de", que enruta la solicitud a través de una dirección IP europea.
Funciones para solicitudes post
requests_post(url, answer_type, headers, data, json_data, auth, proxy)
! url - es un enlace donde se realiza la solicitud,
answer_type - es un parámetro opcional que define qué debe devolverse de la respuesta del servidor: ('status' – devuelve el código de estado de la respuesta; 'json' – devuelve el cuerpo json de la respuesta; 'text' – devuelve el texto sin procesar de la respuesta; cualquier otro valor (incluido el predeterminado) devuelve una respuesta en el formato: '{"status": status_code, "data": data}')
headers - es un parámetro opcional para pasar encabezados de solicitud
data - es un parámetro opcional; representa el cuerpo de la solicitud cuando la API no funciona con json.
json_data - es un parámetro opcional; también representa el cuerpo de la solicitud. Debes usar solo uno de estos parámetros a la vez.
Ten en cuenta: ciertas configuraciones de encabezados pueden bloquear el envío de la solicitud con un tipo específico de cuerpo.
auth - es un parámetro opcional útil para la autenticación de API. Si no deseas usar ningún parámetro opcional pero necesitas el siguiente, pasa 0 aquí
proxy - es un parámetro opcional; acepta un valor: "de", que enruta la solicitud a través de una dirección IP europea.
Funciones para solicitudes put
requests_put(url, answer_type, headers, data, auth, proxy)
! url - es un enlace donde se realiza la solicitud
answer_type - es un parámetro opcional que define qué debe devolverse de la respuesta del servidor: ('status' – devuelve el código de estado de la respuesta; 'json' – devuelve el cuerpo json de la respuesta; 'text' – devuelve el texto sin procesar de la respuesta; cualquier otro valor (incluido el predeterminado) devuelve una respuesta en el formato: '{"status": status_code, "data": data}')
headers - es un parámetro opcional para pasar encabezados de solicitud
data - es un parámetro opcional; representa el cuerpo de la solicitud cuando la API no funciona con json.
auth - es un parámetro opcional útil para la autenticación de API. Si no deseas usar ningún parámetro opcional pero necesitas el siguiente, pasa 0 aquí
proxy - es un parámetro opcional; acepta un valor: "de", que enruta la solicitud a través de una dirección IP europea.
data_is_json es un parámetro opcional.
Si se establece, los datos pasados en data se enviarán en formato JSON.
Para habilitarlo, pasa '1'.
Funciones para solicitudes patch
requests_patch(url, answer_type, headers, data, auth, proxy)
! url - es un enlace donde se realiza la solicitud
answer_type - es un parámetro opcional que define qué debe devolverse de la respuesta del servidor: ('status' – devuelve el código de estado de la respuesta; 'json' – devuelve el cuerpo json de la respuesta; 'text' – devuelve el texto sin procesar de la respuesta; cualquier otro valor (incluido el predeterminado) devuelve una respuesta en el formato: '{"status": status_code, "data": data}')
headers - es un parámetro opcional para pasar encabezados de solicitud
data - es un parámetro opcional; representa el cuerpo de la solicitud cuando la API no funciona con json.
auth - es un parámetro opcional útil para la autenticación de API. Si no deseas usar ningún parámetro opcional pero necesitas el siguiente, pasa 0 aquí
proxy - es un parámetro opcional; acepta un valor: "de", que enruta la solicitud a través de una dirección IP europea.
Funciones para solicitudes delete
requests_delete(url, answer_type, headers, data, json_data, auth, proxy)
! url - es un enlace donde se realiza la solicitud
answer_type - es un parámetro opcional que define qué debe devolverse de la respuesta del servidor: ('status' – devuelve el código de estado de la respuesta; 'json' – devuelve el cuerpo json de la respuesta; 'text' – devuelve el texto sin procesar de la respuesta; cualquier otro valor (incluido el predeterminado) devuelve una respuesta en el formato: '{"status": status_code, "data": data}')
headers - es un parámetro opcional para pasar encabezados de solicitud
data - es un parámetro opcional; representa el cuerpo de la solicitud cuando la API no funciona con json.
json_data - es opcional y también puede usarse como el cuerpo de la solicitud. Sin embargo, solo se debe usar una opción a la vez
auth - es un parámetro opcional útil para la autenticación de API. Si no deseas usar ningún parámetro opcional pero necesitas el siguiente, pasa 0 aquí
proxy - es un parámetro opcional; acepta un valor: "de", que enruta la solicitud a través de una dirección IP europea.
Función para obtener el nombre de un bloque por su ID
get_block_name_by_id(block_id)
! block_id — identificador del bloque (id)