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:

Parámetro
Descripción

description

Pasar una cadena vacía como descripción del bot eliminará la descripción existente.

language_code

Un código de idioma de dos letras según el estándar ISO 639-1 para la localización del texto.

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.

chevron-rightEjemplohashtag

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

Configuración de un bloque en MaviBot: uso de funciones para establecer comandos y descripciones

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

Mensaje de bienvenida y menú del bot

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')

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:

Parámetro
Descripción

description

Pasar una cadena vacía como descripción del bot eliminará la descripción existente.

language_code

Un código de idioma de dos letras según el estándar ISO 639-1 para la localización del texto.

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.

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.

Parámetro
Descripción

language_code

Un código de idioma de dos letras según el estándar ISO 639-1 para la localización del texto.

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.

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.

Parámetro
Descripción

language_code

Un código de idioma de dos letras según el estándar ISO 639-1 para la localización del texto.

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.

Cómo configurar comandos para el bot

Para configurar comandos

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

Parámetro
Descripción

! commands

Comandos del bot en forma de una lista de listas; cada lista anidada consta de 2 elementos:

1 – el nombre del comando, 2 – su descripción (hay un límite de 100 comandos).

language

Un código de idioma de dos letras según ISO 639-1, por ejemplo, 'ru' o 'en'.

Si no se especifica, los comandos se aplicarán a todos los usuarios cuyo idioma no tenga comandos asignados específicamente.

scope

Un parámetro que define el ámbito de usuarios para los que se crean los comandos. El valor predeterminado es 'default'.

platform_id

Identificador del chat dentro de Telegram *.

Se aplica solo a valores específicos del scope parámetro.

user_id

Identificador de usuario dentro de Telegram *.

Se aplica solo a valores específicos del scope parámetro.

chevron-rightEjemplohashtag

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')

circle-exclamation

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

Cómo ver los comandos del bot

tg_get_command()

Para ver los comandos

tg_get_command(language, scope, platform_id, user_id)

Parámetro
Descripción

language

Un código de idioma de dos letras según ISO 639-1, por ejemplo, 'ru' o 'en'. 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.

scope

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 'default' se aplicará).

platform_id

Identificador del chat dentro de Telegram *.

Se aplica solo a valores específicos del scope parámetro.

user_id

Identificador de usuario dentro de Telegram *.

Se aplica solo a valores específicos del scope parámetro..

circle-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)

chevron-rightEjemplohashtag

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()

Cómo eliminar comandos en el bot

tg_delete_command()

Para eliminar comandos

tg_delete_command(language, scope, platform_id, user_id), donde

Parámetro
Descripción

language

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).

scope

Un parámetro que define el ámbito de usuarios para los que se eliminarán los comandos. Si no se especifica, el valor predeterminado 'default' se aplicará.

platform_id

Identificador del chat (parámetro opcional, se aplica solo a valores específicos del parámetro de ámbito).

user_id

Identificador de usuario (parámetro opcional, se aplica solo a valores específicos del parámetro de ámbito).

circle-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)

circle-info

Un comando como tg_delete_command() eliminará los comandos sin especificar el parámetro de idioma, usando el valor predeterminado del ámbito.

chevron-rightEjemplohashtag

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

Ejemplo de código para copiar:

tg_delete_command('', 'all_chat_administrators')

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:

Parámetro
Valor

'default'

El parámetro predeterminado implica que los comandos funcionarán en mensajes privados con el bot.

'all_private_chats'

Todos los chats privados: los comandos están disponibles para todos en los chats privados donde se haya añadido el bot.

'all_group_chats'

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.

'all_chat_administrators'

Comandos para administradores de todos los chats de grupo y supergrupo donde se haya añadido el bot.

'chat'

Comandos para un chat específico (si eliges esta opción, debes especificar el platform_id).

'chat_administrators'

Comandos para administradores de un chat específico (si eliges esta opción, debes especificar el platform_id).

'chat_member'

Comandos para un miembro específico de un chat en particular (si eliges esta opción, debes especificar tanto platform_id y user_id; el usuario especificado debe ser miembro del chat dado).

circle-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)

Última actualización