Як працювати з описом 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)