Использование бота
Как работать с описанием 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 параметра..
Если вы не хотите использовать параметр языка, но нужно использовать параметр scope, обязательно укажите сначала пустой параметр, как в примере:
tg_get_command('', scope)
Пример
command = tg_get_command('', 'all_chat_administrators')
Присвойте результат этой функции переменной, и в переменной будет содержаться ответ сервера с командами для области пользователей, указанной в параметре.
{"ok":true,"result":[{"command":"count","description":"вернуть количество пользователей"},{"command":"unpin","description":"открепить все сообщения"}]}
Если функция вызывается без параметров, scope будет установлен в '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).
Если вы не хотите использовать параметр языка, но нужно использовать параметр scope, обязательно укажите пустое значение для первого параметра, как в примере:
tg_delete_command('', scope)
Команда вида tg_delete_command() удалит команды без указания параметра языка, используя значение scope по умолчанию.
Пример
Вы можете удалить заданные команды, вызвав функцию с параметрами в калькуляторе:
Пример кода для копирования:
tg_delete_command('', 'all_chat_administrators')
Как настроить реакции на команды
Для команд в личном чате с ботом нужно реагировать на сообщения вида: '/command_name' — где command_name — это команда.
Для команд в группах и чатах сообщения будут выглядеть так: '/command_name@bot_username' — где command_name — это команда, а @bot_username — это имя пользователя бота.
Список значений scope:
'default'
Параметр default означает, что команды будут работать в личных сообщениях с ботом.
'all_private_chats'
Все личные чаты: команды доступны всем в личных чатах, где был добавлен бот.
'all_group_chats'
Все групповые и супергрупповые чаты: команды доступны всем в этих типах чатов, где был добавлен бот.
'all_chat_administrators'
Команды для администраторов всех групповых и супергрупповых чатов, где был добавлен бот.
'chat'
Команды для конкретного чата (если вы выберете этот вариант, вам нужно указать platform_id).
'chat_administrators'
Команды для администраторов конкретного чата (если вы выберете этот вариант, вам нужно указать platform_id).
'chat_member'
Команды для конкретного участника определённого чата (если вы выберете этот вариант, вам нужно указать оба platform_id и user_id; указанный пользователь должен быть участником данного чата).
Если вы не хотите использовать параметр языка, но нужно использовать параметр scope, обязательно укажите пустое значение для первого параметра, как в примере:
tg_delete_command('', scope)
Последнее обновление