Kā strādāt ar Telegram bota aprakstu (pilno un īso)

Lai konfigurētu sveiciena ziņojumu

tg_set_bot_description(description, language_code) - bota apraksts, kas tiek rādīts, kad tērzēšana ar botu ir tukša

Parametri:

Parametrs Apraksts
description Nododot tukšu virkni kā bota aprakstu, esošais apraksts tiks noņemts.
language_code

Divu burtu valodas kods saskaņā ar ISO 639-1 standartu teksta lokalizācijai.

Ja atstāj tukšu, īsais apraksts tiks piemērots visiem lietotājiem, kuriem nav iestatīts konkrēts īsais apraksts.

Piemērs

Piemērs sveiciena ziņojuma un bota izvēlnes konfigurēšanai:

Pēc palaišanas (tas jādara vienu reizi, izmantojot administratora komandu):

Koda piemērs kopēšanai:

tg_set_bot_description('Welcome! I am your virtual assistant, Yurgram.🤖') command = [["private_office", "Personal Account"]] tg_set_command(command, '', 'default')

Lai konfigurētu īso priekšskatījuma aprakstu

tg_set_bot_short_description(description, language_code) - īss bota apraksts, kas parādās bota profila lapā un tiek nosūtīts kopā ar saiti, kad lietotāji kopīgo botu.

Parametri:

Parametrs Apraksts
description Nododot tukšu virkni kā bota aprakstu, esošais apraksts tiks noņemts.
language_code

Divu burtu valodas kods saskaņā ar ISO 639-1 standartu teksta lokalizācijai.

Ja atstāj tukšu, īsais apraksts tiks piemērots visiem lietotājiem, kuriem nav iestatīts konkrēts īsais apraksts.

Lai iegūtu pašreizējo aprakstu

tg_get_bot_description(language_code) - izmantojiet šo metodi, lai iegūtu pašreizējo bota aprakstu norādītajā lietotāja valodā.

Parametrs Apraksts
language_code

Divu burtu valodas kods saskaņā ar ISO 639-1 standartu teksta lokalizācijai.

Ja atstāj tukšu, īsais apraksts tiks piemērots visiem lietotājiem, kuriem nav iestatīts konkrēts īsais apraksts.

Lai iegūtu pašreizējo īso aprakstu

tg_get_bot_short_description(language_code) - izmantojiet šo metodi, lai iegūtu pašreizējo bota īso aprakstu norādītajā lietotāja valodā.

Parametrs Apraksts
language_code

Divu burtu valodas kods saskaņā ar ISO 639-1 standartu teksta lokalizācijai.

Ja atstāj tukšu, īsais apraksts tiks piemērots visiem lietotājiem, kuriem nav iestatīts konkrēts īsais apraksts.

Kā konfigurēt komandas botam

Lai konfigurētu komandas

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

Parametrs Apraksts
**!** commands

Bota komandas sarakstu saraksta formā, katrs iegultais saraksts sastāv no 2 elementiem:

1 – komandas nosaukums, 2 – tās apraksts (ir ierobežojums līdz 100 komandām).

language

Divu burtu valodas kods saskaņā ar ISO 639-1, piem., 'ru' vai 'en'.

Ja nav norādīts, komandas tiks piemērotas visiem lietotājiem, kuru valodai nav īpaši piešķirtas komandas.

scope Parametrs, kas nosaka lietotāju loku, kuriem komandas tiek izveidotas. Noklusējuma vērtība ir 'default'.
platform_id

Tērzēšanas identifikators Telegram *.

Piemērojams tikai konkrētām scope parametra vērtībām.

user_id

Lietotāja identifikators Telegram *.

Piemērojams tikai konkrētām scope parametra vērtībām.

Piemērs

command = [["count", "return count of user"],["unpin", "unpin all message"]] tg_set_command(command, '', 'all_chat_administrators')

Šajā piemērā komandas ir ievietotas atsevišķā mainīgajā. Šīs komandas varat pievienot arī tieši funkcijā.

tg_set_command('[["count", "return count of user"],["unpin", "unpin all message"]]', '', 'all_chat_administrators')

Lai izsauktu komandas, ierakstiet '/' simbolu ziņojuma ievades laukā. Ja viss ir konfigurēts pareizi, jūs redzēsiet pieejamo komandu ieteikumu sarakstu. Komandas tiks parādītas treknrakstā, un to apraksti būs redzami pa labi.

Lai izmantotu komandas, konfigurējiet reakciju uz ziņojumiem, kas satur komandas.

Kā skatīt bota komandas

tg_get_command()

Lai skatītu komandas

tg_get_command(language, scope, platform_id, user_id)

Parametrs Apraksts
language Divu burtu valodas kods saskaņā ar ISO 639-1, piem., 'ru' vai 'en'.
Ja nav norādīts, tiks rādītas komandas, kas piemērotas visiem lietotājiem noteiktajā apgabalā, kuriem nav īpašu komandu viņu valodai.
scope Parametrs, kas nosaka lietotāju loku, kuriem komandas jārāda (neobligāts parametrs; ja netiek izmantots, tiks piemērota noklusējuma vērtība 'default').
platform_id

Tērzēšanas identifikators Telegram *.

Piemērojams tikai konkrētām scope parametra vērtībām.

user_id

Lietotāja identifikators Telegram *.

Piemērojams tikai konkrētām scope parametra vērtībām.

Ja nevēlaties izmantot valodas parametru, bet jums ir jāizmanto scope parametrs, noteikti vispirms norādiet tukšu parametru, kā piemērā:

tg_get_command('', scope)

Piemērs

command = tg_get_command('', 'all_chat_administrators')

Piešķiriet šo funkciju mainīgajam, un mainīgais saturēs servera atbildi ar komandām lietotāju lokam, kas norādīts parametrā.

{"ok":true,"result":[{"command":"count","description":"return count of user"},{"command":"unpin","description":"unpin all message"}]}

Ja funkcija tiek izsaukta bez parametriem, tvērums tiks iestatīts uz 'default'.

command = tg_get_command()

Kā dzēst bota komandas

tg_delete_command()

Lai dzēstu komandas

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

Parametrs Apraksts
language Divu burtu valodas kods saskaņā ar ISO 639-1, piem., 'ru' vai 'en' (neobligāts parametrs; ja nav norādīts, tiks dzēstas komandas, kas piemērotas visiem lietotājiem noteiktajā tvērumā, kuriem nav īpašu komandu viņu valodai).
scope Parametrs, kas nosaka lietotāju loku, kuriem komandas tiks dzēstas.
Ja nav norādīts, tiks piemērota noklusējuma vērtība 'default'.
platform_id Tērzēšanas identifikators (neobligāts parametrs, piemērojams tikai konkrētām scope parametra vērtībām).
user_id Lietotāja identifikators (neobligāts parametrs, piemērojams tikai konkrētām scope parametra vērtībām).

Ja nevēlaties izmantot valodas parametru, bet jums ir jāizmanto scope parametrs, noteikti norādiet tukšu vērtību pirmajam parametram, kā piemērā:

tg_delete_command('', scope)

Komanda, piemēram, tg_delete_command(), dzēsīs komandas, nenorādot valodas parametru, izmantojot noklusējuma tvēruma vērtību.

Piemērs

Jūs varat dzēst iestatītās komandas, izsaucot funkciju ar parametriem kalkulatorā:

Koda piemērs kopēšanai:

tg_delete_command('', 'all_chat_administrators')

Kā konfigurēt reakcijas uz komandām

Komandām privātā tērzēšanā ar botu jums ir jāreaģē uz ziņojumiem, piemēram: '/command_name' – kur command_name ir komanda.

Komandām grupās un tērzēšanās ziņojumi parādīsies kā: '/command_name@bot_username' – kur command_name ir komanda un @bot_username ir bota lietotājvārds.

Tvēruma vērtību saraksts:

Parametrs Vērtība
'default' Noklusējuma parametrs nozīmē, ka komandas darbosies privātos ziņojumos ar botu.
'all_private_chats' Visas privātās tērzēšanas: komandas ir pieejamas ikvienam privātās tērzēšanās, kurās bots ir pievienots.
'all_group_chats' Visas grupu un supergrupu tērzēšanas: komandas ir pieejamas ikvienam šāda veida tērzēšanās, kurās bots ir pievienots.
'all_chat_administrators' Komandas visu grupu un supergrupu tērzēšanas administratoriem, kurās bots ir pievienots.
'chat' Komandas konkrētai tērzēšanai (ja izvēlaties šo opciju, jānorāda platform_id).
'chat_administrators' Komandas konkrētas tērzēšanas administratoriem (ja izvēlaties šo opciju, jānorāda platform_id).
'chat_member' Komandas konkrētam konkrētas tērzēšanas dalībniekam (ja izvēlaties šo opciju, jānorāda gan platform_id, gan user_id; norādītajam lietotājam jābūt šīs tērzēšanas dalībniekam).

Ja nevēlaties izmantot valodas parametru, bet jums ir jāizmanto scope parametrs, noteikti norādiet tukšu vērtību pirmajam parametram, kā piemērā:

tg_delete_command('', scope)