# Uso del bot

## Cómo trabajar con una descripción de un bot de Telegram (completa y corta)

### Para configurar el mensaje de bienvenida

**tg\_set\_bot\_description(description, language\_code)** - descripción del bot mostrada cuando el chat con el bot está vacío

Parámetros:

<table><thead><tr><th width="315.25">Parámetro</th><th>Descripción</th></tr></thead><tbody><tr><td><strong>description</strong></td><td>Pasar una cadena vacía como descripción del bot eliminará la descripción existente.</td></tr><tr><td><strong>language_code</strong></td><td><p>Un código de idioma de dos letras según el estándar ISO 639-1 para la localización del texto.</p><p></p><p>Si se deja vacío, la descripción corta se aplicará a todos los usuarios que no tengan una descripción corta específica configurada.</p></td></tr></tbody></table>

<details>

<summary>Ejemplo</summary>

Ejemplo de configuración de un mensaje de bienvenida y del menú del bot:

<div data-with-frame="true"><figure><img src="/files/c6e5a0946e34dcd05deb12fcecee3d66944090bb" alt="" width="563"><figcaption><p>Configuración de un bloque en MaviBot: uso de funciones para establecer comandos y descripciones</p></figcaption></figure></div>

Después del lanzamiento (esto debe hacerse una vez usando un comando de administrador):

<div data-with-frame="true"><figure><img src="/files/d29a2a5d5131ece03d8440bde39045b08dea43d5" alt="" width="375"><figcaption><p>Mensaje de bienvenida y menú del bot</p></figcaption></figure></div>

Ejemplo de código para copiar:

`tg_set_bot_description('¡Bienvenido! Soy tu asistente virtual, Yurgram.🤖') command = [["private_office", "Cuenta personal"]] tg_set_command(command, '', 'default')`

</details>

### Para configurar una breve descripción de vista previa

**tg\_set\_bot\_short\_description(description, language\_code)** - una breve descripción del bot que aparece en la página de perfil del bot y se envía junto con el enlace cuando los usuarios comparten el bot.

Parámetros:

<table><thead><tr><th width="315.25">Parámetro</th><th>Descripción</th></tr></thead><tbody><tr><td><strong>description</strong></td><td>Pasar una cadena vacía como descripción del bot eliminará la descripción existente.</td></tr><tr><td><strong>language_code</strong></td><td><p>Un código de idioma de dos letras según el estándar ISO 639-1 para la localización del texto.</p><p></p><p>Si se deja vacío, la descripción corta se aplicará a todos los usuarios que no tengan una descripción corta específica configurada.</p></td></tr></tbody></table>

### Para obtener la descripción actual

**tg\_get\_bot\_description(language\_code)** - usa este método para obtener la descripción actual del bot para el idioma del usuario especificado.

<table><thead><tr><th width="315.25">Parámetro</th><th>Descripción</th></tr></thead><tbody><tr><td><strong>language_code</strong></td><td><p>Un código de idioma de dos letras según el estándar ISO 639-1 para la localización del texto.</p><p></p><p>Si se deja vacío, la descripción corta se aplicará a todos los usuarios que no tengan una descripción corta específica configurada.</p></td></tr></tbody></table>

### Para obtener la breve descripción actual

**tg\_get\_bot\_short\_description(language\_code)** - usa este método para obtener la breve descripción actual del bot para el idioma del usuario especificado.

<table><thead><tr><th width="315.25">Parámetro</th><th>Descripción</th></tr></thead><tbody><tr><td><strong>language_code</strong></td><td><p>Un código de idioma de dos letras según el estándar ISO 639-1 para la localización del texto.</p><p></p><p>Si se deja vacío, la descripción corta se aplicará a todos los usuarios que no tengan una descripción corta específica configurada.</p></td></tr></tbody></table>

## Cómo configurar comandos para el bot

### Para configurar comandos

**`tg_set_command(commands, language, scope, platform_id, user_id)`**

<table><thead><tr><th width="239.27734375">Parámetro </th><th>Descripción</th></tr></thead><tbody><tr><td><mark style="color:rojo;"><strong>!</strong></mark><strong> commands</strong></td><td><p>Comandos del bot en forma de una lista de listas; cada lista anidada consta de 2 elementos:
<br></p><p>1 – el nombre del comando, 2 – su descripción (hay un límite de 100 comandos).</p></td></tr><tr><td><strong>language</strong></td><td><p>Un código de idioma de dos letras según ISO 639-1, por ejemplo, 'ru' o 'en'.</p><p></p><p>Si no se especifica, los comandos se aplicarán a todos los usuarios cuyo idioma no tenga comandos asignados específicamente.</p></td></tr><tr><td><strong>scope</strong></td><td>Un parámetro que define el ámbito de usuarios para los que se crean los comandos. El valor predeterminado es <em><strong>'default'</strong></em>.</td></tr><tr><td><strong>platform_id</strong></td><td><p>Identificador del chat dentro de Telegram <a href="#gde-vzyat-platform_id-dlya-otpravki-uvedomlenii"><strong>*</strong></a>. </p><p></p><p>Se aplica solo a valores específicos del <strong>scope</strong> parámetro.</p></td></tr><tr><td><strong>user_id</strong></td><td><p>Identificador de usuario dentro de Telegram <a href="#gde-vzyat-platform_id-dlya-otpravki-uvedomlenii"><strong>*</strong></a>. </p><p></p><p>Se aplica solo a valores específicos del <strong>scope</strong> parámetro.</p></td></tr></tbody></table>

<details>

<summary>Ejemplo</summary>

<div data-with-frame="true"><figure><img src="/files/3124ef4eba4bcb13cdfcce359f22b339cb8f08c7" alt="" width="563"><figcaption></figcaption></figure></div>

**command = \[\["count", "devolver el conteo de usuarios"],\["unpin", "desanclar todos los mensajes"]] tg\_set\_command(command, '', 'all\_chat\_administrators')**

En este ejemplo, los comandos se colocan en una variable separada. También puedes agregar estos comandos directamente en la función.

**tg\_set\_command('\[\["count", "devolver el conteo de usuarios"],\["unpin", "desanclar todos los mensajes"]]', '', 'all\_chat\_administrators')**

{% hint style="warning" %}
Para invocar los comandos, escribe el símbolo '/' en el campo de entrada del mensaje. Si todo se configuró correctamente, verás una lista de sugerencias de los comandos disponibles. Los comandos aparecerán en negrita, con sus descripciones mostradas a la derecha.
{% endhint %}

Para usar comandos, configura una reacción a los mensajes que contengan comandos.

</details>

## **Cómo ver los comandos del bot**

### **tg\_get\_command()** &#x20;

<mark style="color:predeterminado;background-color:blue;">**Para ver los comandos**</mark>

**`tg_get_command(language, scope, platform_id, user_id)`**

<table><thead><tr><th width="262.8671875">Parámetro</th><th>Descripción</th></tr></thead><tbody><tr><td><strong>language</strong></td><td>Un código de idioma de dos letras según ISO 639-1, por ejemplo, 'ru' o 'en'.
<br>Si no se especifica, se mostrarán los comandos aplicados a todos los usuarios dentro del área dada que no tengan comandos dedicados para su idioma.</td></tr><tr><td><strong>scope</strong></td><td>Un parámetro que define el ámbito de usuarios para los que deben mostrarse los comandos (parámetro opcional; si no se usa, el valor predeterminado <em><strong>'default'</strong></em> se aplicará).</td></tr><tr><td><strong>platform_id</strong> </td><td><p>Identificador del chat dentro de Telegram <a href="#gde-vzyat-platform_id-dlya-otpravki-uvedomlenii"><strong>*</strong></a>. <br></p><p>Se aplica solo a valores específicos del <strong>scope</strong> parámetro.</p></td></tr><tr><td><strong>user_id</strong></td><td><p>Identificador de usuario dentro de Telegram <a href="#gde-vzyat-platform_id-dlya-otpravki-uvedomlenii"><strong>*</strong></a>. <br></p><p>Se aplica solo a valores específicos del <strong>scope</strong> parámetro..</p></td></tr></tbody></table>

{% hint style="info" %}
Si no quieres usar el parámetro de idioma pero necesitas usar el parámetro de ámbito, asegúrate de especificar primero un parámetro vacío, como en el ejemplo:

**tg\_get\_command('', scope)**
{% endhint %}

<details>

<summary>Ejemplo</summary>

***command = tg\_get\_command('', 'all\_chat\_administrators')***

Asigna esta función a una variable, y la variable contendrá la respuesta del servidor con los comandos para el ámbito de usuario especificado en el parámetro.

***{"ok":true,"result":\[{"command":"count","description":"devolver el conteo de usuarios"},{"command":"unpin","description":"desanclar todos los mensajes"}]}***

Si la función se llama sin parámetros, el ámbito se establecerá en ***'default'***.

***command = tg\_get\_command()***

</details>

## **Cómo eliminar comandos en el bot**

### **tg\_delete\_command()**

<mark style="color:predeterminado;background-color:blue;">**Para eliminar comandos**</mark>

**tg\_delete\_command(language, scope, platform\_id, user\_id),** donde

<table><thead><tr><th width="308.98828125">Parámetro</th><th>Descripción</th></tr></thead><tbody><tr><td><strong>language</strong></td><td>Un código de idioma de dos letras según ISO 639-1, por ejemplo, 'ru' o 'en' (parámetro opcional; si no se especifica, se eliminarán los comandos aplicados a todos los usuarios dentro del ámbito dado que no tengan comandos dedicados para su idioma).</td></tr><tr><td><strong>scope</strong></td><td>Un parámetro que define el ámbito de usuarios para los que se eliminarán los comandos.
<br>Si no se especifica, el valor predeterminado <em><strong>'default'</strong></em> se aplicará.</td></tr><tr><td><strong>platform_id</strong></td><td>Identificador del chat (parámetro opcional, se aplica solo a valores específicos del parámetro de ámbito).</td></tr><tr><td><strong>user_id</strong></td><td>Identificador de usuario (parámetro opcional, se aplica solo a valores específicos del parámetro de ámbito).</td></tr></tbody></table>

{% hint style="info" %}
Si no quieres usar el parámetro de idioma pero necesitas usar el parámetro de ámbito, asegúrate de especificar un valor vacío para el primer parámetro, como en el ejemplo:

**tg\_delete\_command('', scope)**
{% endhint %}

{% hint style="info" %}
Un comando como tg\_delete\_command() eliminará los comandos sin especificar el parámetro de idioma, usando el valor predeterminado del ámbito.
{% endhint %}

<details>

<summary>Ejemplo</summary>

Puedes eliminar los comandos configurados llamando a la función con parámetros en la calculadora:

<div data-with-frame="true"><figure><img src="/files/87c56f4abff2b262b1050dbfe270a995f26ff75d" alt="" width="563"><figcaption></figcaption></figure></div>

**Ejemplo de código para copiar:**

**`tg_delete_command('', 'all_chat_administrators')`**

</details>

## Cómo configurar reacciones a los comandos

Para comandos en un chat privado con el bot, debes reaccionar a mensajes como: **'/command\_name'** – donde **command\_name** es el comando.

Para comandos en grupos y chats, los mensajes aparecerán como: **'/command\_name\@bot\_username'** – donde **command\_name** es el comando y **@bot\_username** es el nombre de usuario del bot.

**Lista de valores de scope:**

<table><thead><tr><th width="214.984375">Parámetro</th><th>Valor</th></tr></thead><tbody><tr><td><strong>'default'</strong></td><td>El parámetro predeterminado implica que los comandos funcionarán en mensajes privados con el bot.</td></tr><tr><td><strong>'all_private_chats'</strong></td><td>Todos los chats privados: los comandos están disponibles para todos en los chats privados donde se haya añadido el bot.</td></tr><tr><td><strong>'all_group_chats'</strong></td><td>Todos los chats de grupo y supergrupo: los comandos están disponibles para todos en este tipo de chats donde se haya añadido el bot.</td></tr><tr><td><strong>'all_chat_administrators'</strong> </td><td>Comandos para administradores de todos los chats de grupo y supergrupo donde se haya añadido el bot.</td></tr><tr><td><strong>'chat'</strong></td><td>Comandos para un chat específico (si eliges esta opción, debes especificar el <strong>platform_id</strong>).</td></tr><tr><td><strong>'chat_administrators'</strong></td><td>Comandos para administradores de un chat específico (si eliges esta opción, debes especificar el <strong>platform_id</strong>).</td></tr><tr><td><strong>'chat_member'</strong></td><td>Comandos para un miembro específico de un chat en particular (si eliges esta opción, debes especificar tanto <strong>platform_id</strong> y <strong>user_id</strong>; el usuario especificado debe ser miembro del chat dado).</td></tr></tbody></table>

{% hint style="info" %}
Si no quieres usar el parámetro de idioma pero necesitas usar el parámetro de ámbito, asegúrate de especificar un valor vacío para el primer parámetro, como en el ejemplo:

**tg\_delete\_command('', scope)**
{% endhint %}


---

# 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/mensajeros/telegram/api/chatbot.md?ask=<question>
```

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.