Como trabalhar com a descrição do bot do Telegram (completa e curta)

Para configurar a mensagem de boas-vindas

tg_set_bot_description(description, language_code) - descrição do bot exibida quando o chat com o bot está vazio

Parâmetros:

Parâmetro Descrição
description Passar uma string vazia como descrição do bot removerá a descrição existente.
language_code

Um código de idioma de duas letras de acordo com o padrão ISO 639-1 para localização de texto.

Se deixado vazio, a descrição curta será aplicada a todos os usuários que não possuem uma descrição curta específica definida.
Exemplo

Exemplo de configuração de uma mensagem de boas-vindas e menu do bot:

Após a inicialização (isso deve ser feito uma vez usando um comando de administrador):

Exemplo de código para copiar:

tg_set_bot_description('Bem-vindo! Eu sou seu assistente virtual, Yurgram.🤖') command = [["private_office", "Conta Pessoal"]] tg_set_command(command, '', 'default')

Para configurar a descrição curta de pré-visualização

tg_set_bot_short_description(description, language_code) - uma descrição curta do bot que aparece na página de perfil do bot e é enviada junto com o link quando os usuários compartilham o bot.

Parâmetros:

Parâmetro Descrição
description Passar uma string vazia como descrição do bot removerá a descrição existente.
language_code

Um código de idioma de duas letras de acordo com o padrão ISO 639-1 para localização de texto.

Se deixado vazio, a descrição curta será aplicada a todos os usuários que não possuem uma descrição curta específica definida.

Para obter a descrição atual

tg_get_bot_description(language_code) - use este método para obter a descrição atual do bot para o idioma do usuário especificado.

Parâmetro Descrição
language_code

Um código de idioma de duas letras de acordo com o padrão ISO 639-1 para localização de texto.

Se deixado vazio, a descrição curta será aplicada a todos os usuários que não possuem uma descrição curta específica definida.

Para obter a descrição curta atual

tg_get_bot_short_description(language_code) - use este método para obter a descrição curta atual do bot para o idioma do usuário especificado.

Parâmetro Descrição
language_code

Um código de idioma de duas letras de acordo com o padrão ISO 639-1 para localização de texto.

Se deixado vazio, a descrição curta será aplicada a todos os usuários que não possuem uma descrição curta específica definida.

Como configurar comandos para o bot

Para configurar comandos

tg_set_command(commands, language, scope, platform_id, user_id)

Parâmetro Descrição
**!** commands

Comandos do bot na forma de uma lista de listas, cada lista aninhada consiste em 2 elementos:

1 – o nome do comando, 2 – sua descrição (há um limite de 100 comandos).
language

Um código de idioma de duas letras de acordo com ISO 639-1, por exemplo, 'ru' ou 'en'.

Se não for especificado, os comandos se aplicarão a todos os usuários cujo idioma não tenha comandos especificamente atribuídos.
scope Um parâmetro que define o escopo de usuários para os quais os comandos são criados. O valor padrão é 'default'.
platform_id

Identificador do chat no Telegram *.

Aplica-se apenas para valores específicos do parâmetro scope.
user_id

Identificador do usuário no Telegram *.

Aplica-se apenas para valores específicos do parâmetro scope.
Exemplo

command = [["count", "retornar contagem de usuário"],["unpin", "desafixar todas as mensagens"]] tg_set_command(command, '', 'all_chat_administrators')

Neste exemplo, os comandos são colocados em uma variável separada. Você também pode adicionar esses comandos diretamente na função.

tg_set_command('[["count", "retornar contagem de usuário"],["unpin", "desafixar todas as mensagens"]]', '', 'all_chat_administrators')

Para chamar os comandos, digite o símbolo '/' no campo de entrada de mensagem. Se tudo foi configurado corretamente, você verá uma lista de sugestões de comandos disponíveis. Os comandos aparecerão em negrito, com suas descrições mostradas à direita.

Para usar comandos, configure uma reação a mensagens que contenham comandos.

Como visualizar comandos para o bot

tg_get_command()

Para visualizar comandos

tg_get_command(language, scope, platform_id, user_id)

Parâmetro Descrição
language Um código de idioma de duas letras de acordo com ISO 639-1, por exemplo, 'ru' ou 'en'.
Se não for especificado, serão mostrados comandos aplicados a todos os usuários dentro da área determinada que não possuem comandos dedicados para seu idioma.
scope Um parâmetro que define o escopo de usuários para os quais os comandos devem ser mostrados (parâmetro opcional; se não for usado, o valor padrão 'default' será aplicado).
platform_id

Identificador do chat no Telegram *.

Aplica-se apenas para valores específicos do parâmetro scope.
user_id

Identificador do usuário no Telegram *.

Aplica-se apenas para valores específicos do parâmetro scope.

Se você não quiser usar o parâmetro de idioma, mas precisar usar o parâmetro de escopo, certifique-se de especificar primeiro um parâmetro vazio, como no exemplo:

tg_get_command('', scope)

Exemplo

command = tg_get_command('', 'all_chat_administrators')

Atribua esta função a uma variável, e a variável conterá a resposta do servidor com comandos para o escopo de usuário especificado no parâmetro.

{"ok":true,"result":[{"command":"count","description":"retornar contagem de usuário"},{"command":"unpin","description":"desafixar todas as mensagens"}]}

Se a função for chamada sem parâmetros, o escopo será definido como 'default'.

command = tg_get_command()

Como excluir comandos no bot

tg_delete_command()

Para excluir comandos

tg_delete_command(language, scope, platform_id, user_id), onde

Parâmetro Descrição
language Um código de idioma de duas letras de acordo com ISO 639-1, por exemplo, 'ru' ou 'en' (parâmetro opcional; se não for especificado, comandos aplicados a todos os usuários dentro do escopo determinado que não possuem comandos dedicados para seu idioma serão excluídos).
scope Um parâmetro que define o escopo de usuários para os quais os comandos serão excluídos.
Se não for especificado, o valor padrão 'default' será aplicado.
platform_id Identificador do chat (parâmetro opcional, aplica-se apenas para valores específicos do parâmetro scope).
user_id Identificador do usuário (parâmetro opcional, aplica-se apenas para valores específicos do parâmetro scope).

Se você não quiser usar o parâmetro de idioma, mas precisar usar o parâmetro de escopo, certifique-se de especificar um valor vazio para o primeiro parâmetro, como no exemplo:

tg_delete_command('', scope)

Um comando como tg_delete_command() excluirá comandos sem especificar o parâmetro de idioma, usando o valor de escopo padrão.

Exemplo

Você pode excluir os comandos definidos chamando a função com parâmetros na calculadora:

Exemplo de código para copiar:

tg_delete_command('', 'all_chat_administrators')

Como configurar reações a comandos

Para comandos em um chat privado com o bot, você precisa reagir a mensagens como: '/command_name' – onde command_name é o comando.

Para comandos em grupos e chats, as mensagens aparecerão como: '/command_name@bot_username' – onde command_name é o comando e @bot_username é o nome de usuário do bot.

Lista de valores de escopo:

Parâmetro Valor
'default' O parâmetro padrão implica que os comandos funcionarão em mensagens privadas com o bot.
'all_private_chats' Todos os chats privados: comandos estão disponíveis para todos em chats privados onde o bot foi adicionado.
'all_group_chats' Todos os chats de grupo e supergrupo: comandos estão disponíveis para todos nesses tipos de chats onde o bot foi adicionado.
'all_chat_administrators' Comandos para administradores de todos os chats de grupo e supergrupo onde o bot foi adicionado.
'chat' Comandos para um chat específico (se você escolher esta opção, deve especificar o platform_id).
'chat_administrators' Comandos para administradores de um chat específico (se você escolher esta opção, deve especificar o platform_id).
'chat_member' Comandos para um membro específico de um chat específico (se você escolher esta opção, deve especificar tanto platform_id quanto user_id; o usuário especificado deve ser um membro do chat determinado).

Se você não quiser usar o parâmetro de idioma, mas precisar usar o parâmetro de escopo, certifique-se de especificar um valor vazio para o primeiro parâmetro, como no exemplo:

tg_delete_command('', scope)