How to work with a Telegram bot description (full and short)
To configure welcome message
tg_set_bot_description(description, language_code) - bot description shown when the chat with the bot is empty
Parameters:
Example of configuring a welcome message and bot menu:
After the launch (this should be done once using an administrator command):
Code example for copying:
tg_set_bot_description('Welcome! I am your virtual assistant, Yurgram.🤖') command = [["private_office", "Personal Account"]] tg_set_command(command, '', 'default')
To configure short preview description
tg_set_bot_short_description(description, language_code) - a short description of the bot that appears on the bot’s profile page and is sent along with the link when users share the bot.
Parameters:
To get current description
tg_get_bot_description(language_code) - use this method to get the current bot description for the specified user language.
To get current short description
tg_get_bot_short_description(language_code) - use this method to get the current short description of the bot for the specified user language.
How to configure commands for the bot
To configure commands
tg_set_command(commands, language, scope, platform_id, user_id)
command = [["count", "return count of user"],["unpin", "unpin all message"]] tg_set_command(command, '', 'all_chat_administrators')
In this example, the commands are placed in a separate variable. You can also add these commands directly into the function.
tg_set_command('[["count", "return count of user"],["unpin", "unpin all message"]]', '', 'all_chat_administrators')
To call the commands, type the '/' symbol in the message input field. If everything was configured correctly, you'll see a suggestion list of available commands. The commands will appear in bold, with their descriptions shown to the right.
To use commands, configure a reaction to messages containing commands.
How to view commands for the bot
tg_get_command()
To view commands
tg_get_command(language, scope, platform_id, user_id)
If you do not want to use the language parameter but need to use the scope parameter, be sure to specify an empty parameter first, as in the example:
tg_get_command('', scope)
command = tg_get_command('', 'all_chat_administrators')
Assign this function to a variable, and the variable will contain the server’s response with commands for the user scope specified in the parameter.
{"ok":true,"result":[{"command":"count","description":"return count of user"},{"command":"unpin","description":"unpin all message"}]}
If the function is called without parameters, the scope will be set to 'default'.
command = tg_get_command()
How to delete commands in the bot
tg_delete_command()
To delete commands
tg_delete_command(language, scope, platform_id, user_id), where
If you do not want to use the language parameter but need to use the scope parameter, be sure to specify an empty value for the first parameter, as in the example:
tg_delete_command('', scope)
A command like tg_delete_command() will delete commands without specifying the language parameter, using the default scope value.
You can delete the set commands by calling the function with parameters in the calculator:
Code example for copying:
tg_delete_command('', 'all_chat_administrators')
How to configure reactions to commands
For commands in a private chat with the bot, you need to react to messages like: '/command_name' – where command_name is the command.
For commands in groups and chats, messages will appear as: '/command_name@bot_username' – where command_name is the command and @bot_username is the bot’s username.
Scope values list:
If you do not want to use the language parameter but need to use the scope parameter, be sure to specify an empty value for the first parameter, as in the example:
tg_delete_command('', scope)