Comment travailler avec une description de 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 :
| Paramètre | Description |
|---|---|
| description | Passer une chaîne vide comme description du bot supprimera la description existante. |
| language_code |
Un code de langue à deux lettres selon la norme ISO 639-1 pour la localisation du texte. Si laissé vide, la description courte sera appliquée à tous les utilisateurs qui n'ont pas de description courte spécifique définie. |
Exemple
Exemple de configuration d'un message de bienvenue et du menu du bot :
Après le lancement (cela doit être fait une fois à l'aide d'une commande administrateur) :
Exemple de code à copier :
tg_set_bot_description('Bienvenue ! Je suis votre assistant virtuel, Yurgram.🤖') command = [["private_office", "Espace personnel"]] tg_set_command(command, '', 'default')
Pour configurer la description courte de l'aperçu
tg_set_bot_short_description(description, language_code) - une description courte 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 :
| Paramètre | Description |
|---|---|
| description | Passer une chaîne vide comme description du bot supprimera la description existante. |
| language_code |
Un code de langue à deux lettres selon la norme ISO 639-1 pour la localisation du texte. Si laissé vide, la description courte sera appliquée à tous les utilisateurs qui n'ont pas de description courte spécifique définie. |
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.
| Paramètre | Description |
|---|---|
| language_code |
Un code de langue à deux lettres selon la norme ISO 639-1 pour la localisation du texte. Si laissé vide, la description courte sera appliquée à tous les utilisateurs qui n'ont pas de description courte spécifique définie. |
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.
| Paramètre | Description |
|---|---|
| language_code |
Un code de langue à deux lettres selon la norme ISO 639-1 pour la localisation du texte. Si laissé vide, la description courte sera appliquée à tous les utilisateurs qui n'ont pas de description courte spécifique définie. |
Comment configurer les commandes pour le bot
Pour configurer les commandes
tg_set_command(commands, language, scope, platform_id, user_id)
| Paramètre | Description |
|---|---|
| **!** commands |
Commandes du bot sous forme de liste de listes, chaque liste imbriquée se compose de 2 éléments :
1 – le nom de la commande, 2 – sa description (il y a une limite de 100 commandes). |
| language |
Un code de langue à deux lettres selon ISO 639-1, par exemple 'ru' ou 'en'. Si non spécifié, les commandes s'appliqueront à tous les utilisateurs dont la langue n'a pas de commandes spécifiquement attribuées. |
| scope | 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 'default'. |
| platform_id |
Identifiant du chat dans Telegram *. S'applique uniquement pour des valeurs spécifiques du paramètre scope. |
| user_id |
Identifiant de l'utilisateur dans Telegram *. S'applique uniquement pour des valeurs spécifiques du paramètre scope. |
Exemple
command = [["count", "retourner le nombre d'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", "retourner le nombre d'utilisateurs"],["unpin", "désépingler tous les messages"]]', '', 'all_chat_administrators')
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.
Pour utiliser les commandes, configurez une réaction aux messages contenant des commandes.
Comment afficher les commandes pour le bot
tg_get_command()
Pour afficher les commandes
tg_get_command(language, scope, platform_id, user_id)
| Paramètre | Description |
|---|---|
| language | Un code de langue à deux lettres selon ISO 639-1, par exemple 'ru' ou 'en'.
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. |
| scope | Un paramètre qui définit le périmètre des utilisateurs pour lesquels les commandes doivent être affichées (paramètre optionnel ; s'il n'est pas utilisé, la valeur par défaut 'default' sera appliquée). |
| platform_id |
Identifiant du chat dans Telegram *. S'applique uniquement pour des valeurs spécifiques du paramètre scope. |
| user_id |
Identifiant de l'utilisateur dans Telegram *. S'applique uniquement pour des valeurs spécifiques du paramètre scope. |
Si vous ne souhaitez pas utiliser le paramètre language mais devez utiliser le paramètre scope, assurez-vous de spécifier d'abord un paramètre vide, comme dans l'exemple :
tg_get_command('', scope)
Exemple
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 utilisateur spécifié dans le paramètre.
{"ok":true,"result":[{"command":"count","description":"retourner le nombre d'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()
Comment supprimer les commandes dans le bot
tg_delete_command()
Pour supprimer les commandes
tg_delete_command(language, scope, platform_id, user_id), où
| Paramètre | Description |
|---|---|
| language | Un code de langue à deux lettres selon ISO 639-1, par exemple 'ru' ou 'en' (paramètre optionnel ; 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). |
| scope | Un paramètre qui définit le périmètre des utilisateurs pour lesquels les commandes seront supprimées.
Si non spécifié, la valeur par défaut 'default' sera appliquée. |
| platform_id | Identifiant du chat (paramètre optionnel, s'applique uniquement pour des valeurs spécifiques du paramètre scope). |
| user_id | Identifiant de l'utilisateur (paramètre optionnel, s'applique uniquement pour des valeurs spécifiques du paramètre scope). |
Si vous ne souhaitez pas utiliser le paramètre language mais devez utiliser le paramètre scope, assurez-vous de spécifier une valeur vide pour le premier paramètre, comme dans l'exemple :
tg_delete_command('', scope)
Une commande comme tg_delete_command() supprimera les commandes sans spécifier le paramètre language, en utilisant la valeur de périmètre par défaut.
Exemple
Vous pouvez supprimer les commandes définies en appelant la fonction avec des paramètres dans la calculatrice :
Exemple de code à copier :
tg_delete_command('', 'all_chat_administrators')
Comment configurer les réactions aux commandes
Pour les commandes dans un chat privé avec le bot, vous devez réagir aux 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 de périmètre :
| Paramètre | Valeur |
|---|---|
| 'default' | Le paramètre par défaut implique que les commandes fonctionneront dans les messages privés avec le bot. |
| 'all_private_chats' | Tous les chats privés : les commandes sont disponibles pour tout le monde dans les chats privés où le bot a été ajouté. |
| 'all_group_chats' | Tous les chats de groupe et supergroupe : les commandes sont disponibles pour tout le monde dans ces types de chats où le bot a été ajouté. |
| 'all_chat_administrators' | Commandes pour les administrateurs de tous les chats de groupe et supergroupe où le bot a été ajouté. |
| 'chat' | Commandes pour un chat spécifique (si vous choisissez cette option, vous devez spécifier le platform_id). |
| 'chat_administrators' | Commandes pour les administrateurs d'un chat spécifique (si vous choisissez cette option, vous devez spécifier le platform_id). |
| 'chat_member' | Commandes pour un membre spécifique d'un chat particulier (si vous choisissez cette option, vous devez spécifier à la fois platform_id et user_id ; l'utilisateur spécifié doit être membre du chat donné). |
Si vous ne souhaitez pas utiliser le paramètre language mais devez utiliser le paramètre scope, assurez-vous de spécifier une valeur vide pour le premier paramètre, comme dans l'exemple :
tg_delete_command('', scope)