Cómo trabajar con la 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 que se muestra 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. |
Ejemplo
Ejemplo de configuración de un mensaje de bienvenida y menú del bot:
Después del lanzamiento (esto debe hacerse una vez usando un comando de administrador):
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 la descripción corta de vista previa
tg_set_bot_short_description(description, language_code) - una descripción corta 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 de 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 descripción corta actual
tg_get_bot_short_description(language_code) - usa este método para obtener la descripción corta actual del bot para el idioma de 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 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 quienes se crean los comandos. El valor predeterminado es 'default'. |
| platform_id |
Identificador del chat dentro de Telegram *. Se aplica solo para valores específicos del parámetro scope. |
| user_id |
Identificador de usuario dentro de Telegram *. Se aplica solo para valores específicos del parámetro scope. |
Ejemplo
command = [["count", "devuelve el recuento 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", "devuelve el recuento de usuarios"],["unpin", "desanclar todos los mensajes"]]', '', 'all_chat_administrators')
Para llamar a los comandos, escribe el símbolo '/' en el campo de entrada de mensajes. Si todo se configuró correctamente, verás una lista de sugerencias de comandos disponibles. Los comandos aparecerán en negrita, con sus descripciones mostradas a la derecha.
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 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 quienes se deben mostrar los comandos (parámetro opcional; si no se usa, se aplicará el valor predeterminado 'default'). |
| platform_id |
Identificador del chat dentro de Telegram *. Se aplica solo para valores específicos del parámetro scope. |
| user_id |
Identificador de usuario dentro de Telegram *. Se aplica solo para valores específicos del parámetro scope. |
Si no deseas usar el parámetro de idioma pero necesitas usar el parámetro scope, asegúrate de especificar primero un parámetro vacío, como en el ejemplo:
tg_get_command('', scope)
Ejemplo
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":"devuelve el recuento 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 quienes se eliminarán los comandos.
Si no se especifica, se aplicará el valor predeterminado 'default'. |
| platform_id | Identificador del chat (parámetro opcional, se aplica solo para valores específicos del parámetro scope). |
| user_id | Identificador de usuario (parámetro opcional, se aplica solo para valores específicos del parámetro scope). |
Si no deseas usar el parámetro de idioma pero necesitas usar el parámetro scope, asegúrate de especificar un valor vacío para el primer parámetro, como en el ejemplo:
tg_delete_command('', scope)
Un comando como tg_delete_command() eliminará comandos sin especificar el parámetro de idioma, usando el valor de ámbito predeterminado.
Ejemplo
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 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 chats privados donde se haya agregado el bot. |
| 'all_group_chats' | Todos los chats de grupo y supergrupo: los comandos están disponibles para todos en estos tipos de chats donde se haya agregado el bot. |
| 'all_chat_administrators' | Comandos para administradores de todos los chats de grupo y supergrupo donde se haya agregado 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 como user_id; el usuario especificado debe ser miembro del chat dado). |
Si no deseas usar el parámetro de idioma pero necesitas usar el parámetro scope, asegúrate de especificar un valor vacío para el primer parámetro, como en el ejemplo:
tg_delete_command('', scope)