# Uso do bot

## Como trabalhar com a descrição de um 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:

<table><thead><tr><th width="315.25">Parâmetro</th><th>Descrição</th></tr></thead><tbody><tr><td><strong>description</strong></td><td>Passar uma string vazia como descrição do bot removerá a descrição existente.</td></tr><tr><td><strong>language_code</strong></td><td><p>Um código de idioma de duas letras de acordo com o padrão ISO 639-1 para localização de texto.</p><p></p><p>Se deixada em branco, a descrição curta será aplicada a todos os usuários que não tiverem uma descrição curta específica definida.</p></td></tr></tbody></table>

<details>

<summary>Exemplo</summary>

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

<div data-with-frame="true"><figure><img src="/files/3204bf55d01e4d6531d7f088f01e57abe9dc5051" alt="" width="563"><figcaption><p>Configurando um bloco no MaviBot: usando funções para definir comandos e descrições</p></figcaption></figure></div>

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

<div data-with-frame="true"><figure><img src="/files/b9cfa08f4701b3c84cb45f3c3bd2459580814d4a" alt="" width="375"><figcaption><p>Mensagem de boas-vindas e menu do bot</p></figcaption></figure></div>

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')`

</details>

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

**tg\_set\_bot\_short\_description(description, language\_code)** - uma breve descrição 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:

<table><thead><tr><th width="315.25">Parâmetro</th><th>Descrição</th></tr></thead><tbody><tr><td><strong>description</strong></td><td>Passar uma string vazia como descrição do bot removerá a descrição existente.</td></tr><tr><td><strong>language_code</strong></td><td><p>Um código de idioma de duas letras de acordo com o padrão ISO 639-1 para localização de texto.</p><p></p><p>Se deixada em branco, a descrição curta será aplicada a todos os usuários que não tiverem uma descrição curta específica definida.</p></td></tr></tbody></table>

### 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 especificado do usuário.

<table><thead><tr><th width="315.25">Parâmetro</th><th>Descrição</th></tr></thead><tbody><tr><td><strong>language_code</strong></td><td><p>Um código de idioma de duas letras de acordo com o padrão ISO 639-1 para localização de texto.</p><p></p><p>Se deixada em branco, a descrição curta será aplicada a todos os usuários que não tiverem uma descrição curta específica definida.</p></td></tr></tbody></table>

### 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 especificado do usuário.

<table><thead><tr><th width="315.25">Parâmetro</th><th>Descrição</th></tr></thead><tbody><tr><td><strong>language_code</strong></td><td><p>Um código de idioma de duas letras de acordo com o padrão ISO 639-1 para localização de texto.</p><p></p><p>Se deixada em branco, a descrição curta será aplicada a todos os usuários que não tiverem uma descrição curta específica definida.</p></td></tr></tbody></table>

## Como configurar comandos para o bot

### Para configurar comandos

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

<table><thead><tr><th width="239.27734375">Parâmetro </th><th>Descrição</th></tr></thead><tbody><tr><td><mark style="color:vermelho;"><strong>!</strong></mark><strong> commands</strong></td><td><p>Comandos do bot na forma de uma lista de listas, em que cada lista aninhada consiste em 2 elementos:
<br></p><p>1 – o nome do comando, 2 – sua descrição (há um limite de 100 comandos).</p></td></tr><tr><td><strong>language</strong></td><td><p>Um código de idioma de duas letras de acordo com a ISO 639-1, por exemplo, 'ru' ou 'en'.</p><p></p><p>Se não for especificado, os comandos serão aplicados a todos os usuários cujo idioma não tenha comandos atribuídos especificamente.</p></td></tr><tr><td><strong>scope</strong></td><td>Um parâmetro que define o escopo de usuários para os quais os comandos são criados. O valor padrão é <em><strong>'default'</strong></em>.</td></tr><tr><td><strong>platform_id</strong></td><td><p>Identificador do chat no Telegram <a href="#gde-vzyat-platform_id-dlya-otpravki-uvedomlenii"><strong>*</strong></a>. </p><p></p><p>Aplica-se apenas a valores específicos do <strong>scope</strong> parâmetro.</p></td></tr><tr><td><strong>user_id</strong></td><td><p>Identificador do usuário no Telegram <a href="#gde-vzyat-platform_id-dlya-otpravki-uvedomlenii"><strong>*</strong></a>. </p><p></p><p>Aplica-se apenas a valores específicos do <strong>scope</strong> parâmetro.</p></td></tr></tbody></table>

<details>

<summary>Exemplo</summary>

<div data-with-frame="true"><figure><img src="/files/53c12a200ee0701f4dcce89e6292cd654dc0b6d0" alt="" width="563"><figcaption></figcaption></figure></div>

**command = \[\["count", "retornar contagem de usuários"],\["unpin", "desfixar 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 à função.

**tg\_set\_command('\[\["count", "retornar contagem de usuários"],\["unpin", "desfixar todas as mensagens"]]', '', 'all\_chat\_administrators')**

{% hint style="warning" %}
Para chamar os comandos, digite o símbolo '/' no campo de entrada da mensagem. Se tudo tiver sido 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.
{% endhint %}

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

</details>

## **Como ver os comandos do bot**

### **tg\_get\_command()** &#x20;

<mark style="color:padrão;background-color:blue;">**Para ver comandos**</mark>

**`tg_get_command(language, scope, platform_id, user_id)`**

<table><thead><tr><th width="262.8671875">Parâmetro</th><th>Descrição</th></tr></thead><tbody><tr><td><strong>language</strong></td><td>Um código de idioma de duas letras de acordo com a ISO 639-1, por exemplo, 'ru' ou 'en'.
<br>Se não for especificado, serão exibidos os comandos aplicados a todos os usuários dentro da área dada que não tenham comandos dedicados para seu idioma.</td></tr><tr><td><strong>scope</strong></td><td>Um parâmetro que define o escopo de usuários para os quais os comandos devem ser exibidos (parâmetro opcional; se não for usado, o valor padrão <em><strong>'default'</strong></em> será aplicado).</td></tr><tr><td><strong>platform_id</strong> </td><td><p>Identificador do chat no Telegram <a href="#gde-vzyat-platform_id-dlya-otpravki-uvedomlenii"><strong>*</strong></a>. <br></p><p>Aplica-se apenas a valores específicos do <strong>scope</strong> parâmetro.</p></td></tr><tr><td><strong>user_id</strong></td><td><p>Identificador do usuário no Telegram <a href="#gde-vzyat-platform_id-dlya-otpravki-uvedomlenii"><strong>*</strong></a>. <br></p><p>Aplica-se apenas a valores específicos do <strong>scope</strong> parâmetro..</p></td></tr></tbody></table>

{% hint style="info" %}
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)**
{% endhint %}

<details>

<summary>Exemplo</summary>

***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 os comandos para o escopo de usuário especificado no parâmetro.

***{"ok":true,"result":\[{"command":"count","description":"retornar contagem de usuários"},{"command":"unpin","description":"desfixar todas as mensagens"}]}***

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

***command = tg\_get\_command()***

</details>

## **Como excluir comandos no bot**

### **tg\_delete\_command()**

<mark style="color:padrão;background-color:blue;">**Para excluir comandos**</mark>

**tg\_delete\_command(language, scope, platform\_id, user\_id),** onde

<table><thead><tr><th width="308.98828125">Parâmetro</th><th>Descrição</th></tr></thead><tbody><tr><td><strong>language</strong></td><td>Um código de idioma de duas letras de acordo com a ISO 639-1, por exemplo, 'ru' ou 'en' (parâmetro opcional; se não for especificado, serão excluídos os comandos aplicados a todos os usuários dentro do escopo definido que não tenham comandos dedicados para seu idioma).</td></tr><tr><td><strong>scope</strong></td><td>Um parâmetro que define o escopo de usuários para os quais os comandos serão excluídos.
<br>Se não for especificado, o valor padrão <em><strong>'default'</strong></em> será aplicado.</td></tr><tr><td><strong>platform_id</strong></td><td>Identificador do chat (parâmetro opcional, aplica-se apenas a valores específicos do parâmetro scope).</td></tr><tr><td><strong>user_id</strong></td><td>Identificador do usuário (parâmetro opcional, aplica-se apenas a valores específicos do parâmetro scope).</td></tr></tbody></table>

{% hint style="info" %}
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)**
{% endhint %}

{% hint style="info" %}
Um comando como tg\_delete\_command() excluirá comandos sem especificar o parâmetro de idioma, usando o valor padrão de escopo.
{% endhint %}

<details>

<summary>Exemplo</summary>

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

<div data-with-frame="true"><figure><img src="/files/39901f6f03a8070681a70373b42d0c06342d4ed8" alt="" width="563"><figcaption></figcaption></figure></div>

**Exemplo de código para copiar:**

**`tg_delete_command('', 'all_chat_administrators')`**

</details>

## Como configurar reações aos 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:**

<table><thead><tr><th width="214.984375">Parâmetro</th><th>Valor</th></tr></thead><tbody><tr><td><strong>'default'</strong></td><td>O parâmetro padrão implica que os comandos funcionarão em mensagens privadas com o bot.</td></tr><tr><td><strong>'all_private_chats'</strong></td><td>Todos os chats privados: os comandos estão disponíveis para todos nos chats privados em que o bot foi adicionado.</td></tr><tr><td><strong>'all_group_chats'</strong></td><td>Todos os chats de grupo e supergrupo: os comandos estão disponíveis para todos nesses tipos de chat em que o bot foi adicionado.</td></tr><tr><td><strong>'all_chat_administrators'</strong> </td><td>Comandos para administradores de todos os chats de grupo e supergrupo em que o bot foi adicionado.</td></tr><tr><td><strong>'chat'</strong></td><td>Comandos para um chat específico (se você escolher esta opção, deverá especificar o <strong>platform_id</strong>).</td></tr><tr><td><strong>'chat_administrators'</strong></td><td>Comandos para administradores de um chat específico (se você escolher esta opção, deverá especificar o <strong>platform_id</strong>).</td></tr><tr><td><strong>'chat_member'</strong></td><td>Comandos para um membro específico de um determinado chat (se você escolher esta opção, deverá especificar ambos <strong>platform_id</strong> e <strong>user_id</strong>; o usuário especificado deve ser um membro do chat informado).</td></tr></tbody></table>

{% hint style="info" %}
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)**
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.mavibot.ai/doc/pt/chatbot/mensageiros/telegram/api/chatbot.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.