# Utilisation du bot

## Comment travailler avec la description d’un bot Telegram (complète et courte)

### Pour configurer le message de bienvenue

**tg\_set\_bot\_description(description, language\_code)** - description du bot affichée lorsque la conversation avec le bot est vide

Paramètres :

<table><thead><tr><th width="315.25">Paramètre</th><th>Description</th></tr></thead><tbody><tr><td><strong>description</strong></td><td>En passant une chaîne vide comme description du bot, la description existante sera supprimée.</td></tr><tr><td><strong>language_code</strong></td><td><p>Un code de langue à deux lettres conformément à la norme ISO 639-1 pour la localisation du texte.</p><p></p><p>Si laissé vide, la description courte sera appliquée à tous les utilisateurs qui n’ont pas de description courte spécifique définie.</p></td></tr></tbody></table>

<details>

<summary>Exemple</summary>

Exemple de configuration d’un message de bienvenue et du menu du bot :

<div data-with-frame="true"><figure><img src="/files/7422362c57c85c0781c0e0174f9ceb95ae3a3a33" alt="" width="563"><figcaption><p>Configuration d’un bloc dans MaviBot : utilisation de fonctions pour définir les commandes et les descriptions</p></figcaption></figure></div>

Après le lancement (cela doit être fait une seule fois à l’aide d’une commande administrateur) :

<div data-with-frame="true"><figure><img src="/files/98af2310e1920183201d9b670612d941094af03d" alt="" width="375"><figcaption><p>Message de bienvenue et menu du bot</p></figcaption></figure></div>

Exemple de code à copier :

`commande tg_set_bot_description('Bienvenue ! Je suis votre assistant virtuel, Yurgram.🤖') = [["private_office", "Compte personnel"]] tg_set_command(command, '', 'default')`

</details>

### Pour configurer la description courte d’aperçu

**tg\_set\_bot\_short\_description(description, language\_code)** - une courte description du bot qui apparaît sur la page de profil du bot et est envoyée avec le lien lorsque les utilisateurs partagent le bot.

Paramètres :

<table><thead><tr><th width="315.25">Paramètre</th><th>Description</th></tr></thead><tbody><tr><td><strong>description</strong></td><td>En passant une chaîne vide comme description du bot, la description existante sera supprimée.</td></tr><tr><td><strong>language_code</strong></td><td><p>Un code de langue à deux lettres conformément à la norme ISO 639-1 pour la localisation du texte.</p><p></p><p>Si laissé vide, la description courte sera appliquée à tous les utilisateurs qui n’ont pas de description courte spécifique définie.</p></td></tr></tbody></table>

### Pour obtenir la description actuelle

**tg\_get\_bot\_description(language\_code)** - utilisez cette méthode pour obtenir la description actuelle du bot pour la langue utilisateur spécifiée.

<table><thead><tr><th width="315.25">Paramètre</th><th>Description</th></tr></thead><tbody><tr><td><strong>language_code</strong></td><td><p>Un code de langue à deux lettres conformément à la norme ISO 639-1 pour la localisation du texte.</p><p></p><p>Si laissé vide, la description courte sera appliquée à tous les utilisateurs qui n’ont pas de description courte spécifique définie.</p></td></tr></tbody></table>

### Pour obtenir la description courte actuelle

**tg\_get\_bot\_short\_description(language\_code)** - utilisez cette méthode pour obtenir la description courte actuelle du bot pour la langue utilisateur spécifiée.

<table><thead><tr><th width="315.25">Paramètre</th><th>Description</th></tr></thead><tbody><tr><td><strong>language_code</strong></td><td><p>Un code de langue à deux lettres conformément à la norme ISO 639-1 pour la localisation du texte.</p><p></p><p>Si laissé vide, la description courte sera appliquée à tous les utilisateurs qui n’ont pas de description courte spécifique définie.</p></td></tr></tbody></table>

## Comment configurer les commandes du bot

### Pour configurer les commandes

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

<table><thead><tr><th width="239.27734375">Paramètre </th><th>Description</th></tr></thead><tbody><tr><td><mark style="color:red;"><strong>!</strong></mark><strong> commands</strong></td><td><p>Commandes du bot sous forme de liste de listes, chaque liste imbriquée se compose de 2 éléments :
<br></p><p>1 – le nom de la commande, 2 – sa description (il y a une limite de 100 commandes).</p></td></tr><tr><td><strong>language</strong></td><td><p>Un code de langue à deux lettres selon ISO 639-1, par ex. 'ru' ou 'en'.</p><p></p><p>Si non spécifié, les commandes s’appliqueront à tous les utilisateurs dont la langue n’a pas de commandes spécifiquement attribuées.</p></td></tr><tr><td><strong>scope</strong></td><td>Un paramètre qui définit le périmètre des utilisateurs pour lesquels les commandes sont créées. La valeur par défaut est <em><strong>'default'</strong></em>.</td></tr><tr><td><strong>platform_id</strong></td><td><p>Identifiant du chat dans Telegram <a href="#gde-vzyat-platform_id-dlya-otpravki-uvedomlenii"><strong>*</strong></a>. </p><p></p><p>S’applique uniquement à des valeurs spécifiques du <strong>scope</strong> paramètre.</p></td></tr><tr><td><strong>user_id</strong></td><td><p>Identifiant de l’utilisateur dans Telegram <a href="#gde-vzyat-platform_id-dlya-otpravki-uvedomlenii"><strong>*</strong></a>. </p><p></p><p>S’applique uniquement à des valeurs spécifiques du <strong>scope</strong> paramètre.</p></td></tr></tbody></table>

<details>

<summary>Exemple</summary>

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

**command = \[\["count", "compter les utilisateurs"],\["unpin", "désépingler tous les messages"]] tg\_set\_command(command, '', 'all\_chat\_administrators')**

Dans cet exemple, les commandes sont placées dans une variable séparée. Vous pouvez également ajouter ces commandes directement dans la fonction.

**tg\_set\_command('\[\["count", "compter les utilisateurs"],\["unpin", "désépingler tous les messages"]]', '', 'all\_chat\_administrators')**

{% hint style="warning" %}
Pour appeler les commandes, tapez le symbole '/' dans le champ de saisie du message. Si tout a été configuré correctement, vous verrez une liste de suggestions des commandes disponibles. Les commandes apparaîtront en gras, avec leurs descriptions affichées à droite.
{% endhint %}

Pour utiliser les commandes, configurez une réaction aux messages contenant des commandes.

</details>

## **Comment voir les commandes du bot**

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

<mark style="background-color:blue;">**Pour voir les commandes**</mark>

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

<table><thead><tr><th width="262.8671875">Paramètre</th><th>Description</th></tr></thead><tbody><tr><td><strong>language</strong></td><td>Un code de langue à deux lettres conformément à ISO 639-1, par ex. 'ru' ou 'en'.
<br>Si non spécifié, les commandes appliquées à tous les utilisateurs dans la zone donnée qui n’ont pas de commandes dédiées pour leur langue seront affichées.</td></tr><tr><td><strong>scope</strong></td><td>Un paramètre qui définit le périmètre des utilisateurs pour lesquels les commandes doivent être affichées (paramètre facultatif ; s’il n’est pas utilisé, la valeur par défaut <em><strong>'default'</strong></em> sera appliquée).</td></tr><tr><td><strong>platform_id</strong> </td><td><p>Identifiant du chat dans Telegram <a href="#gde-vzyat-platform_id-dlya-otpravki-uvedomlenii"><strong>*</strong></a>. <br></p><p>S’applique uniquement à des valeurs spécifiques du <strong>scope</strong> paramètre.</p></td></tr><tr><td><strong>user_id</strong></td><td><p>Identifiant de l’utilisateur dans Telegram <a href="#gde-vzyat-platform_id-dlya-otpravki-uvedomlenii"><strong>*</strong></a>. <br></p><p>S’applique uniquement à des valeurs spécifiques du <strong>scope</strong> paramètre..</p></td></tr></tbody></table>

{% hint style="info" %}
Si vous ne voulez pas utiliser le paramètre de langue mais devez utiliser le paramètre de périmètre, veillez à spécifier d’abord un paramètre vide, comme dans l’exemple :

**tg\_get\_command('', scope)**
{% endhint %}

<details>

<summary>Exemple</summary>

***command = tg\_get\_command('', 'all\_chat\_administrators')***

Attribuez cette fonction à une variable, et la variable contiendra la réponse du serveur avec les commandes pour le périmètre d’utilisateurs spécifié dans le paramètre.

***{"ok":true,"result":\[{"command":"count","description":"compter les utilisateurs"},{"command":"unpin","description":"désépingler tous les messages"}]}***

Si la fonction est appelée sans paramètres, le périmètre sera défini sur ***'default'***.

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

</details>

## **Comment supprimer les commandes dans le bot**

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

<mark style="background-color:blue;">**Pour supprimer les commandes**</mark>

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

<table><thead><tr><th width="308.98828125">Paramètre</th><th>Description</th></tr></thead><tbody><tr><td><strong>language</strong></td><td>Un code de langue à deux lettres conformément à ISO 639-1, par ex. 'ru' ou 'en' (paramètre facultatif ; s’il n’est pas spécifié, les commandes appliquées à tous les utilisateurs dans le périmètre donné qui n’ont pas de commandes dédiées pour leur langue seront supprimées).</td></tr><tr><td><strong>scope</strong></td><td>Un paramètre qui définit le périmètre des utilisateurs pour lesquels les commandes seront supprimées.
<br>S’il n’est pas spécifié, la valeur par défaut <em><strong>'default'</strong></em> sera appliquée.</td></tr><tr><td><strong>platform_id</strong></td><td>Identifiant du chat (paramètre facultatif, s’applique uniquement à des valeurs spécifiques du paramètre scope).</td></tr><tr><td><strong>user_id</strong></td><td>Identifiant de l’utilisateur (paramètre facultatif, s’applique uniquement à des valeurs spécifiques du paramètre scope).</td></tr></tbody></table>

{% hint style="info" %}
Si vous ne voulez pas utiliser le paramètre de langue mais devez utiliser le paramètre de périmètre, veillez à spécifier une valeur vide pour le premier paramètre, comme dans l’exemple :

**tg\_delete\_command('', scope)**
{% endhint %}

{% hint style="info" %}
Une commande comme tg\_delete\_command() supprimera les commandes sans spécifier le paramètre de langue, en utilisant la valeur par défaut du périmètre.
{% endhint %}

<details>

<summary>Exemple</summary>

Vous pouvez supprimer les commandes définies en appelant la fonction avec des paramètres dans le calculateur :

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

**Exemple de code à copier :**

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

</details>

## Comment configurer les réactions aux commandes

Pour les commandes dans une discussion privée avec le bot, vous devez réagir à des messages comme : **'/command\_name'** – où **command\_name** est la commande.

Pour les commandes dans les groupes et les chats, les messages apparaîtront comme : **'/command\_name\@bot\_username'** – où **command\_name** est la commande et **@bot\_username** est le nom d’utilisateur du bot.

**Liste des valeurs du périmètre :**

<table><thead><tr><th width="214.984375">Paramètre</th><th>Valeur</th></tr></thead><tbody><tr><td><strong>'default'</strong></td><td>Le paramètre par défaut implique que les commandes fonctionneront dans les messages privés avec le bot.</td></tr><tr><td><strong>'all_private_chats'</strong></td><td>Tous les chats privés : les commandes sont disponibles pour tout le monde dans les chats privés où le bot a été ajouté.</td></tr><tr><td><strong>'all_group_chats'</strong></td><td>Tous les chats de groupe et de supergroupe : les commandes sont disponibles pour tout le monde dans ces types de chats où le bot a été ajouté.</td></tr><tr><td><strong>'all_chat_administrators'</strong> </td><td>Commandes pour les administrateurs de tous les chats de groupe et de supergroupe où le bot a été ajouté.</td></tr><tr><td><strong>'chat'</strong></td><td>Commandes pour un chat spécifique (si vous choisissez cette option, vous devez spécifier le <strong>platform_id</strong>).</td></tr><tr><td><strong>'chat_administrators'</strong></td><td>Commandes pour les administrateurs d’un chat spécifique (si vous choisissez cette option, vous devez spécifier le <strong>platform_id</strong>).</td></tr><tr><td><strong>'chat_member'</strong></td><td>Commandes pour un membre spécifique d’un chat particulier (si vous choisissez cette option, vous devez spécifier à la fois <strong>platform_id</strong> et <strong>user_id</strong>; l’utilisateur spécifié doit être membre du chat donné).</td></tr></tbody></table>

{% hint style="info" %}
Si vous ne voulez pas utiliser le paramètre de langue mais devez utiliser le paramètre de périmètre, veillez à spécifier une valeur vide pour le premier paramètre, comme dans l’exemple :

**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/fr/chatbot/messageries/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.