Как работать с описанием Telegram-бота (полным и кратким)

Настройка приветственного сообщения

tg_set_bot_description(description, language_code) — описание бота, отображаемое, когда чат с ботом пуст.

Параметры:

Параметр Описание
description Передача пустой строки в качестве описания бота удалит существующее описание.
language_code

Двухбуквенный код языка в соответствии со стандартом ISO 639-1 для локализации текста.

Если оставить пустым, краткое описание будет применено ко всем пользователям, у которых не установлено конкретное краткое описание.
Пример

Пример настройки приветственного сообщения и меню бота:

После запуска (это нужно сделать один раз с помощью команды администратора):

Пример кода для копирования:

tg_set_bot_description('Добро пожаловать! Я ваш виртуальный помощник, Yurgram.🤖') command = [["private_office", "Личный кабинет"]] tg_set_command(command, '', 'default')

Настройка краткого описания для предпросмотра

tg_set_bot_short_description(description, language_code) — краткое описание бота, которое отображается на странице профиля бота и отправляется вместе со ссылкой, когда пользователи делятся ботом.

Параметры:

Параметр Описание
description Передача пустой строки в качестве описания бота удалит существующее описание.
language_code

Двухбуквенный код языка в соответствии со стандартом ISO 639-1 для локализации текста.

Если оставить пустым, краткое описание будет применено ко всем пользователям, у которых не установлено конкретное краткое описание.

Получение текущего описания

tg_get_bot_description(language_code) — используйте этот метод, чтобы получить текущее описание бота для указанного языка пользователя.

Параметр Описание
language_code

Двухбуквенный код языка в соответствии со стандартом ISO 639-1 для локализации текста.

Если оставить пустым, краткое описание будет применено ко всем пользователям, у которых не установлено конкретное краткое описание.

Получение текущего краткого описания

tg_get_bot_short_description(language_code) — используйте этот метод, чтобы получить текущее краткое описание бота для указанного языка пользователя.

Параметр Описание
language_code

Двухбуквенный код языка в соответствии со стандартом ISO 639-1 для локализации текста.

Если оставить пустым, краткое описание будет применено ко всем пользователям, у которых не установлено конкретное краткое описание.

Как настроить команды для бота

Настройка команд

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

Параметр Описание
**!** commands

Команды бота в виде списка списков, каждый вложенный список состоит из 2 элементов:

1 – имя команды, 2 – её описание (ограничение — 100 команд).
language

Двухбуквенный код языка в соответствии с ISO 639-1, например, 'ru' или 'en'.

Если не указан, команды будут применяться ко всем пользователям, для языка которых не назначены специальные команды.
scope Параметр, определяющий область пользователей, для которых создаются команды. Значение по умолчанию — 'default'.
platform_id

Идентификатор чата в Telegram *.

Применяется только для определённых значений параметра scope.
user_id

Идентификатор пользователя в Telegram *.

Применяется только для определённых значений параметра scope.
Пример

command = [["count", "вернуть количество пользователей"],["unpin", "открепить все сообщения"]] tg_set_command(command, '', 'all_chat_administrators')

В этом примере команды помещены в отдельную переменную. Вы также можете добавить эти команды непосредственно в функцию.

tg_set_command('[["count", "вернуть количество пользователей"],["unpin", "открепить все сообщения"]]', '', 'all_chat_administrators')

Чтобы вызвать команды, введите символ '/' в поле ввода сообщения. Если всё настроено правильно, вы увидите список предложений доступных команд. Команды будут отображаться жирным шрифтом, а их описания — справа.

Чтобы использовать команды, настройте реакцию на сообщения, содержащие команды.

Как просмотреть команды для бота

tg_get_command()

Просмотр команд

tg_get_command(language, scope, platform_id, user_id)

Параметр Описание
language Двухбуквенный код языка в соответствии с ISO 639-1, например, 'ru' или 'en'.
Если не указан, будут показаны команды, применяемые ко всем пользователям в заданной области, у которых нет специальных команд для их языка.
scope Параметр, определяющий область пользователей, для которых должны быть показаны команды (необязательный параметр; если не используется, будет применено значение по умолчанию 'default').
platform_id

Идентификатор чата в Telegram *.

Применяется только для определённых значений параметра scope.
user_id

Идентификатор пользователя в Telegram *.

Применяется только для определённых значений параметра scope.

Если вы не хотите использовать параметр language, но вам нужно использовать параметр scope, обязательно сначала укажите пустой параметр, как в примере:

tg_get_command('', scope)

Пример

command = tg_get_command('', 'all_chat_administrators')

Присвойте эту функцию переменной, и переменная будет содержать ответ сервера с командами для области пользователей, указанной в параметре.

{"ok":true,"result":[{"command":"count","description":"вернуть количество пользователей"},{"command":"unpin","description":"открепить все сообщения"}]}

Если функция вызывается без параметров, область будет установлена на 'default'.

command = tg_get_command()

Как удалить команды в боте

tg_delete_command()

Удаление команд

tg_delete_command(language, scope, platform_id, user_id), где

Параметр Описание
language Двухбуквенный код языка в соответствии с ISO 639-1, например, 'ru' или 'en' (необязательный параметр; если не указан, будут удалены команды, применяемые ко всем пользователям в заданной области, у которых нет специальных команд для их языка).
scope Параметр, определяющий область пользователей, для которых будут удалены команды.
Если не указан, будет применено значение по умолчанию 'default'.
platform_id Идентификатор чата (необязательный параметр, применяется только для определённых значений параметра scope).
user_id Идентификатор пользователя (необязательный параметр, применяется только для определённых значений параметра scope).

Если вы не хотите использовать параметр language, но вам нужно использовать параметр scope, обязательно укажите пустое значение для первого параметра, как в примере:

tg_delete_command('', scope)

Команда вида tg_delete_command() удалит команды без указания параметра language, используя значение области по умолчанию.

Пример

Вы можете удалить установленные команды, вызвав функцию с параметрами в калькуляторе:

Пример кода для копирования:

tg_delete_command('', 'all_chat_administrators')

Как настроить реакции на команды

Для команд в личном чате с ботом нужно реагировать на сообщения вида: '/command_name' – где command_name — это команда.

Для команд в группах и чатах сообщения будут выглядеть так: '/command_name@bot_username' – где command_name — это команда, а @bot_username — имя пользователя бота.

Список значений scope:

Параметр Значение
'default' Параметр по умолчанию означает, что команды будут работать в личных сообщениях с ботом.
'all_private_chats' Все личные чаты: команды доступны всем в личных чатах, куда добавлен бот.
'all_group_chats' Все групповые и супергрупповые чаты: команды доступны всем в этих типах чатов, куда добавлен бот.
'all_chat_administrators' Команды для администраторов всех групповых и супергрупповых чатов, куда добавлен бот.
'chat' Команды для конкретного чата (если вы выберете этот вариант, следует указать platform_id).
'chat_administrators' Команды для администраторов конкретного чата (если вы выберете этот вариант, следует указать platform_id).
'chat_member' Команды для конкретного участника определённого чата (если вы выберете этот вариант, следует указать как platform_id, так и user_id; указанный пользователь должен быть участником данного чата).

Если вы не хотите использовать параметр language, но вам нужно использовать параметр scope, обязательно укажите пустое значение для первого параметра, как в примере:

tg_delete_command('', scope)