Descripción

**was\_in\_state(message\_id)**\ comprueba si un cliente estuvo en el estado seleccionado (bloque). Puedes obtener el número del bloque desde el editor.

La línea superior del editor de bloques muestra el número del bloque.

**days\_from\_last\_message()**\ determina el número de días desde el último mensaje del cliente. Fue creado para comprobar si entra dentro de la ventana de 24 horas. Ejemplo: \ `d = days_from_last_message()` {% hint style="info" %} Si han pasado más de 30 días desde el último mensaje del cliente, la función devolverá el valor 9999. {% endhint %} \ **liberar*****\_*****cliente()**\ desasigna al operador responsable. Ejemplo: free\_client() **assign\_to\_user(email, only\_active)**\ asigna un diálogo a un operador, donde: 1. email - un parámetro de cadena (opcional). Si solo se proporciona el correo electrónico, el diálogo se asignará al operador especificado sin importar su estado actual. 2. only\_active - Verdadero o Falso (parámetro opcional). Si se establece en Verdadero, el diálogo se asignará al operador especificado solo si está actualmente de turno. Ejemplos: `assign_to_user()` - asigna un diálogo a un operador aleatorio que está actualmente de turno `assign_to_user('correo electrónico del operador')` - asigna un diálogo al operador sin importar su estado `assign_to_user('correo electrónico del operador', True)` - asigna un diálogo al operador especificado solo si está actualmente de turno **distribute\_client()**\ asigna un diálogo al operador según la configuración de autodistribución. \ Ejemplo: `distribute_client()` **get\_operator**()\ recupera el correo electrónico de un operador responsable Ejemplo: `get_operator()` Puede usarse para asignar tareas a un operador responsable o para comprobar si existe. Si no hay un operador responsable, devolverá None. **get\_operator\_name**()\ recupera el nombre del operador responsable Ejemplo: `get_operator_name()` Puede usarse para mostrar información a un cliente. Si no hay un operador responsable, devolverá None. Si el operador no tiene un nombre asignado, devolverá su correo electrónico. **delete\_pended\_messages()**\ elimina todos los mensajes programados para el cliente actual. De forma predeterminada, también elimina los mensajes creados por las **"No cancelar"** flechas. Para conservar los mensajes de las **"No cancelar"** flechas, pasa el parámetro False: delete\_pended\_messages(False). **set\_note(comment)**\ añade un comentario a un diálogo. Ejemplo: **`set_note`**`('Volver a hacer')` **add\_unread(count)**\ marca un diálogo con un cliente como no leído El parámetro count puede omitirse o establecerse en 1; en este caso, el diálogo con el cliente mostrará un indicador de +1 mensaje no leído.

Si se pasa cualquier otro número, se mostrará en la **"Clientes"** sección como el número de mensajes no leídos de un cliente.

**clear\_unread()**\ marca un diálogo como leído **unsubscribe()**\ Función para darse de baja de los mensajes del bot. Se proporciona un ejemplo [en este artículo.](/doc/es/envios-comerciales/darse-de-baja-del-bot.md) Para el cliente dado de baja, aparecerá un símbolo — un mensaje rojo con una cruz.

{% hint style="info" %} **¡Importante!** El **La calculadora se ejecuta primero**, y solo después se envía el mensaje. Por lo tanto, si necesitas enviar un mensaje final como **"Has sido dado de baja del bot"** o **"Has sido bloqueado"**, debes usar un proceso de dos pasos: 1. **Primero, envía un bloque** que contenga el mensaje final. 2. **Luego, envía un bloque vacío** que contenga la función de darse de baja/bloquear. **Si intentas hacer ambas cosas en un solo bloque, el mensaje no se enviará.** {% endhint %}

Si colocas la `unsubscribe()` función en la calculadora del mismo bloque que tu mensaje, el mensaje **no se enviará**, y el sistema mostrará un error.

**block\_client()**\ bloquea a un cliente para que no envíe mensajes al bot. Los mensajes programados previamente desde el bot también se cancelarán. Sin embargo, seguirá siendo posible enviar mensajes al cliente directamente desde el diálogo en la **"Clientes"** sección

Un cliente bloqueado tendrá una marca — un icono de candado rojo.

**unblock\_client()**\ desbloquea al cliente. El cliente podrá interactuar con el bot nuevamente y continuar con las cadenas de mensajes. **set\_client\_name(name)**\ cambia el nombre del cliente. Pasa el nombre del cliente como una cadena entre comillas dobles. También puedes usar una variable que contenga el nombre del cliente, por ejemplo: set\_client\_name("Juan Smith") **get\_bind\_clients()**\ una función sin parámetros que devuelve un array de IDs de clientes vinculados al cliente actual. **get\_current\_pipline\_id()**\ una función sin parámetros que devuelve el ID del embudo en el que se encuentra actualmente el cliente. Si el trato del cliente está en la etapa "sin procesar", devuelve None.

## Trabajando con tareas {% hint style="success" %} Las funciones que trabajan con tareas devuelven el estado de la operación como **True o el ID de la tarea en caso de éxito. En caso de fallo, devuelven False o None.** {% endhint %} {% hint style="info" %} MaviBot utiliza el formato de fecha **"dd.mm.aaaa"** y el formato de hora **"HH:MM"**. {% endhint %} create\_task() | update\_task() | done\_task() | delete\_task()

Descripción

**create\_task(email, name, date\_srok, description, time\_srok)** – crea una tarea Parámetros:\ **!**** correo electrónico** - correo electrónico de la persona responsable\ **!**** name** - nombre de la tarea\ **!**** date\_srok** - fecha de vencimiento, fecha\ **!**** description** - descripción de la tarea\ **time\_srok** - hora de vencimiento, hora **update\_task(task\_id,email, name, date\_srok, description, time\_srok)** - actualiza una tarea Parámetros:\ **!**** task\_id**- ID de la tarea\ **!**** correo electrónico** - correo electrónico de la persona responsable\ **!**** name** - nombre de la tarea\ **!**** date\_srok** - fecha de vencimiento, fecha\ **!**** description** - descripción de la tarea\ **time\_srok** - hora de vencimiento, hora **done\_task(task\_id)**- marca una tarea como completada Parámetros:\ **!**** task\_id**- ID de la tarea **delete\_task(task\_id)** – elimina una tarea Parámetros:\ **!**** task\_id**- ID de la tarea

Ejemplos

Vamos a crear una tarea para el operador:

Actualiza la fecha de vencimiento y la descripción.

Marca la tarea como completada.

Eliminación de la tarea

Ejemplo de código para copiar

`task_id=create_task('admin@mavibot.ai', 'Test', '22.01.2023', 'tarea de prueba', '08:00') status=delete_task(task_id)`

Descripción

**Obteniendo el ID del trato actual** **get\_order\_id()** - devuelve el estado del trato. **Creando un nuevo trato** **create\_order(name, budget, description, client\_name, phone, email, state\_id)**\ El trato activo actualmente en el embudo, junto con sus variables, solo estará disponible en las funciones relacionadas con tratos y en el CRM.\ \ **Parámetros de la función:** \ **!**** name** - (opcional), el nombre del trato. Si no se proporciona, la función se aplica al trato activo actual del cliente. **!**** budget** - (opcional) el valor del trato. Si no se proporciona, se aplica al trato activo actual.\ Si **budget** no es un número, la función devolverá: **el presupuesto debe ser un número** **description** - (opcional), la descripción del trato. Parámetros adicionales para la creación del cliente: **client\_name** - (opcional) cadena, nombre de un nuevo cliente **phone** - (opcional) cadena, número de teléfono de un nuevo cliente. **correo electrónico** - (opcional) cadena, dirección de correo electrónico de un nuevo cliente. Para crear un cliente, debe proporcionarse al menos el teléfono o el correo electrónico. Si se proporciona el teléfono y no existe ningún cliente con este teléfono en el proyecto, se creará uno nuevo. Si se proporciona el correo electrónico sin teléfono y no existe ningún cliente con este correo, se creará uno nuevo. Parámetro adicional: **state\_id** - número, permite establecer el estado inicial del trato al crearlo **Establecer o actualizar el nombre del trato** **set\_order\_name(name, order\_id)** **name** - ❗obligatorio, cadena; el nombre del trato **order\_id** - (opcional) ID del trato. Si no se proporciona, el cambio se aplica al trato activo actual del cliente. **Establecer o actualizar el presupuesto del trato** **set\_order\_budget(budget, order\_id)** **budget** -❗obligatorio, número; el valor del trato **order\_id** - (opcional) ID del trato. Si no se proporciona, se aplica al trato activo actual del cliente. Para usar correctamente order\_id: 1. Puedes especificarlo manualmente: obtén el ID del trato y pásalo como parámetro de la función si quieres dirigirte a un trato específico.

1. Recupéralo usando la función get\_order\_id(), porque la variable integrada order\_id devuelve el valor en el formato {client\_id}-{order\_id}, lo que puede causar un comportamiento incorrecto. **Recuperando listas de tratos** \ ((excluyendo tratos archivados, exitosos o fallidos)) **get\_active\_orders\_ids()** **Obtener una lista de IDs de tratos exitosos** **get\_success\_orders\_ids()** **Obtener una lista de IDs de tratos fallidos** **get\_fail\_orders\_ids()** **Recuperando el valor de una variable del trato** **get\_order\_var(order\_id, variable)** Parámetros: **!**** order\_id** - ID del trato **!**** variable** - nombre de la variable cuyo valor deseas recuperar **Recuperando datos del trato** **get\_order\_vars(order\_id, names)** Parámetros: **!**** order\_id** - ID del trato **names** - un array de nombres de variables a recuperar. Si se omite, la función devuelve todas las variables del trato especificado La función devuelve un diccionario que contiene las variables enumeradas en el **names** array para el trato identificado por **order\_id**. Si **names** no se proporciona, devuelve un diccionario con todas las variables del trato especificado. **Añadiendo una variable al trato** **set\_order\_var(order\_id, variable, value)** Parámetros: **!**** order\_id** - ID del trato **!**** variable** - el nombre de la variable que se añadirá o actualizará en un trato {% hint style="warning" %} Si quieres cambiar los parámetros del trato "name" o "description", usa los nombres de variable "name" o "description" respectivamente. {% endhint %} **!**** value** - valor de la variable **Añadiendo múltiples variables al trato** **set\_order\_vars(order\_id, variables\_dict)** Parámetros: **!**** order\_id** - ID del trato. **!**** variables\_dict** - un diccionario de variables **Moviéndose al siguiente estado del embudo** **move\_order\_to\_next\_state(order\_id)** Parámetros:\ **order\_id** - ID del trato. Si no se especifica, se moverá el trato activo actual.\ El orden de los estados del trato se define según la secuencia establecida en MavibotCRM. **Recuperando la etapa del embudo en MavibotCRM** **get\_state\_id(client\_id, order\_id)** \ También puedes copiar el ID del estado del embudo directamente desde la **"Configuración del estado"**. Parámetros: **order\_id -** ID del trato del cliente Puedes llamar a la función con o sin el **order\_id** parámetro. Si se omite order\_id, la función devolverá el ID del estado del embudo para el trato activo actual. Para el uso correcto de order\_id: 1. Puedes especificarlo manualmente obteniendo el ID del trato y pasándolo como parámetro de la función cuando quieras dirigirte a un trato específico. 2. Recupéralo usando la función get\_order\_id(), porque la variable integrada order\_id devuelve un valor en el formato {client\_id}-{order\_id}, lo que puede causar un comportamiento incorrecto. **Moviendo un lead a través del embudo de MavibotCRM por ID de estado** **change\_state(state\_id, order\_id)** Parámetros:\ **!** **state\_id -** ID del estado del embudo\ **order\_id (** opcional) - el ID del trato a mover a través del embudo. Si se omite, se moverá el trato activo actual. **Obteniendo el ID del trato por nombre y valor de variable** get\_order\_id\_by\_var\_value(var\_name, var\_value, client\_id) Parámetros:\ ! var\_name - nombre de la variable\ ! var\_value - valor de la variable;\ client\_id - (opcional) ID del trato del cliente; por defecto es el ID del cliente en el bot **Obteniendo la fecha y hora del último trato** latest\_order\_datetime(client\_id, dt\_fmt) Parámetros:\ client\_id - (opcional) el ID del trato del cliente; por defecto es el ID del cliente en el bot;\ df\_fmt - (opcional) formato para la fecha y hora devueltas; el valor predeterminado es "%d.%m.%y %H:%M" **Obteniendo el número de tratos del cliente** count\_client\_orders(client\_id, state\_id, get\_all, active) Parámetros:\ client\_id - (opcional) el ID del trato del cliente; por defecto es el ID del cliente en el bot;\ state\_id - (opcional) el ID del estado del trato en el embudo;\ get\_all - (opcional) bandera de filtro para el parámetro active; el valor predeterminado es 1 (el filtrado por active está deshabilitado);\ active - se usa solo cuando get\_all es 0; filtra los tratos activos; el valor predeterminado es 1 (devuelve solo tratos activos); **Obtener el recuento de tratos en un estado específico** get\_count\_orders(id) - devuelve el número de tratos que actualmente están en un estado específico del embudo por ID de estado. La función toma un solo parámetro: **!** id - el ID del estado del trato. Ejemplo de uso de la función:

El ID de la etapa se puede encontrar en la configuración. A continuación, debes introducir la función en la calculadora de la siguiente manera:

Al probar el bot, la respuesta del bot consistirá en el número de tratos en el estado especificado por el valor pasado a la función. **Eliminación de un trato** delete\_order(order\_id) — elimina un trato en **MaviBotCRM**. order\_id - (opcional) el ID del trato a eliminar. Si se omite, se eliminará el trato más reciente.

Ejemplos

Todas las funciones son sencillas de usar. \ Por ejemplo, vamos a crear un nuevo trato y enviar su número al cliente:

Puedes obtener el ID del trato activo actual del cliente usando la función get\_order\_id(), o recuperar la lista completa de los tratos del cliente usando get\_active\_orders\_ids().

Obteniendo el ID del trato activo actual

Ejemplo de código para copiar

/* Crear un nuevo trato */
oid = create_order()

/*Recuperar el ID del trato activo del cliente*/
oid = get_order_id()

/*Recuperar la lista de tratos activos*/
res = get_active_orders_ids()

/*Añadir o actualizar una sola variable en el trato*/
res = set_order_var('40630', 'обновлено', '#{current_date}')

vars = {"VAR1": "V111", "VAR2": "V222"}
res2 = set_order_vars('40630', vars)

ovar = get_order_vars('40630')

### **Estableciendo una etiqueta de trato exitoso** set\_order\_status\_success() {% tabs %} {% tab title="Descripción" %} **set\_order\_status\_success(order\_id)** Parámetros: **order\_id** - el ID del trato. Si el parámetro no se especifica, la etiqueta se establecerá para el trato activo actual. {% endtab %} {% endtabs %} ### **Estableciendo una etiqueta de trato fallido** set\_order\_status\_fail() {% tabs %} {% tab title="Descripción" %} **set\_order\_status\_fail(order\_id)** Parámetros: **order\_id** - el ID del trato. Si el parámetro no se especifica, la etiqueta se establecerá para el trato activo actual. {% endtab %} {% endtabs %} ### **Estableciendo una etiqueta de trato archivado** set\_order\_status\_archive() {% tabs %} {% tab title="Descripción" %} **set\_order\_status\_archive(order\_id)** Parámetros: **order\_id** - el ID del trato. Si el parámetro no se especifica, la etiqueta se establecerá para el trato activo actual. {% endtab %} {% tab title="Ejemplos" %} /\*Archivar el trato activo actual\*/ `res_arh = set_order_status_archive()` {% endtab %} {% endtabs %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.mavibot.ai/doc/es/chatbot/functions/calculadora/crm.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.