Функции для работы с ботом

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

tg_set_bot_description()

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

tg_set_bot_description(description, language_code) - описание бота, показываемое когда чат с ботом пуст

Параметры:

Параметр

Описание

description

описание бота, если передать пустую строку, то это очистит соответствующее описание

language_code

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

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

Пример

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

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

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

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

tg_set_bot_short_description()

Установка описания для превью ссылки

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

Параметры:

Параметр

Описание

description

описание бота, если передать пустую строку, то это удалит соответствующее описание

language_code

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

tg_get_bot_description()

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

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

Параметр

Описание

language_code

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

tg_get_bot_short_description()

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

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

Параметр

Описание

language_code

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

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

tg_set_command()

Для установки команд

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", "return count of user"],["unpin", "unpin all message"]] tg_set_command(command, '', 'all_chat_administrators')

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

tg_set_command('[["count", "return count of user"],["unpin", "unpin all message"]]', '', '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')

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

{"ok":true,"result":[{"command":"count","description":"return count of user"},{"command":"unpin","description":"unpin all message"}]}

Если вызвать функцию без параметров, то 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).

Если Вы не хотите использовать параметр language, но при этом используете параметр scope, то не забудьте указать в начале пустой параметр, как в примере: tg_delete_command('', scope)

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

Пример

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

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

tg_delete_command('', 'all_chat_administrators')

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

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

для команд в чатах при вводе команды будут приходить сообщения вида:

Для команд в группах и чатах реагировать нужно на сообщения вида:

'/command_name@bot_username' – в этом примере command_name – команда, а @bot_username – 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_set_command(command, '', scope)

PreviousФункции API Telegram NextФункции для отправки и редактирования сообщений

Last updated 2 days ago

Was this helpful?