Використання бота
Як працювати з описом 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'
Параметр за замовчуванням означає, що команди працюватимуть у приватних повідомленнях із ботом.
'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)
Last updated