استخدام البوت

كيفية العمل مع وصف بوت تيليجرام (كامل وقصير)

لتكوين رسالة الترحيب

tg_set_bot_description(description, language_code) - وصف البوت الذي يظهر عندما تكون الدردشة مع البوت فارغة

المعلمات:

المعلمة	الوصف
description	سيؤدي تمرير سلسلة فارغة كوصف للبوت إلى إزالة الوصف الحالي.
language_code	رمز لغة مكون من حرفين وفقًا لمعيار ISO 639-1 لتوطين النص. إذا تُرك فارغًا، فسيتم تطبيق الوصف القصير على جميع المستخدمين الذين ليس لديهم وصف قصير محدد.

مثال

مثال لتكوين رسالة ترحيب وقائمة البوت:

بعد التشغيل (يجب القيام بذلك مرة واحدة باستخدام أمر المسؤول):

مثال على الكود للنسخ:

tg_set_bot_description('مرحبًا! أنا مساعدك الافتراضي، Yurgram.🤖') command = [["private_office", "الحساب الشخصي"]] tg_set_command(command, '', 'default')

لتكوين وصف المعاينة القصير

tg_set_bot_short_description(description, language_code) - وصف قصير للبوت يظهر على صفحة ملف البوت ويتم إرساله مع الرابط عندما يشارك المستخدمون البوت.

المعلمات:

المعلمة	الوصف
description	سيؤدي تمرير سلسلة فارغة كوصف للبوت إلى إزالة الوصف الحالي.
language_code	رمز لغة مكون من حرفين وفقًا لمعيار ISO 639-1 لتوطين النص. إذا تُرك فارغًا، فسيتم تطبيق الوصف القصير على جميع المستخدمين الذين ليس لديهم وصف قصير محدد.

للحصول على الوصف الحالي

tg_get_bot_description(language_code) - استخدم هذه الطريقة للحصول على وصف البوت الحالي للغة المستخدم المحددة.

المعلمة	الوصف
language_code	رمز لغة مكون من حرفين وفقًا لمعيار ISO 639-1 لتوطين النص. إذا تُرك فارغًا، فسيتم تطبيق الوصف القصير على جميع المستخدمين الذين ليس لديهم وصف قصير محدد.

للحصول على الوصف القصير الحالي

tg_get_bot_short_description(language_code) - استخدم هذه الطريقة للحصول على الوصف القصير الحالي للبوت للغة المستخدم المحددة.

المعلمة	الوصف
language_code	رمز لغة مكون من حرفين وفقًا لمعيار ISO 639-1 لتوطين النص. إذا تُرك فارغًا، فسيتم تطبيق الوصف القصير على جميع المستخدمين الذين ليس لديهم وصف قصير محدد.

كيفية تكوين الأوامر للبوت

لتكوين الأوامر

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

المعلمة	الوصف
**!** commands	أوامر البوت في شكل قائمة من القوائم، تتكون كل قائمة متداخلة من عنصرين: 1 – اسم الأمر، 2 – وصفه (هناك حد أقصى 100 أمر).
language	رمز لغة مكون من حرفين وفقًا لـ ISO 639-1، على سبيل المثال 'ru' أو 'en'. إذا لم يتم تحديده، فسيتم تطبيق الأوامر على جميع المستخدمين الذين لا تحتوي لغتهم على أوامر مخصصة.
scope	معلمة تحدد نطاق المستخدمين الذين يتم إنشاء الأوامر لهم. القيمة الافتراضية هي 'default'.
platform_id	معرف الدردشة داخل تيليجرام *. ينطبق فقط على قيم محددة لمعلمة scope.
user_id	معرف المستخدم داخل تيليجرام *. ينطبق فقط على قيم محددة لمعلمة scope.

مثال

command = [["count", "إرجاع عدد المستخدمين"],["unpin", "إلغاء تثبيت جميع الرسائل"]] tg_set_command(command, '', 'all_chat_administrators')

في هذا المثال، يتم وضع الأوامر في متغير منفصل. يمكنك أيضًا إضافة هذه الأوامر مباشرة إلى الدالة.

tg_set_command('[["count", "إرجاع عدد المستخدمين"],["unpin", "إلغاء تثبيت جميع الرسائل"]]', '', 'all_chat_administrators')

لاستدعاء الأوامر، اكتب الرمز '/' في حقل إدخال الرسالة. إذا تم تكوين كل شيء بشكل صحيح، سترى قائمة اقتراحات بالأوامر المتاحة. ستظهر الأوامر بخط عريض، مع ظهور أوصافها على اليمين.

لاستخدام الأوامر، قم بتكوين رد فعل على الرسائل التي تحتوي على أوامر.

كيفية عرض الأوامر للبوت

tg_get_command()

لعرض الأوامر

tg_get_command(language, scope, platform_id, user_id)

المعلمة	الوصف
language	رمز لغة مكون من حرفين وفقًا لـ ISO 639-1، على سبيل المثال 'ru' أو 'en'. إذا لم يتم تحديده، فسيتم عرض الأوامر المطبقة على جميع المستخدمين داخل المنطقة المحددة الذين ليس لديهم أوامر مخصصة للغتهم.
scope	معلمة تحدد نطاق المستخدمين الذين يجب عرض الأوامر لهم (معلمة اختيارية؛ إذا لم يتم استخدامها، سيتم تطبيق القيمة الافتراضية 'default').
platform_id	معرف الدردشة داخل تيليجرام *. ينطبق فقط على قيم محددة لمعلمة scope.
user_id	معرف المستخدم داخل تيليجرام *. ينطبق فقط على قيم محددة لمعلمة scope.

إذا كنت لا ترغب في استخدام معلمة اللغة ولكنك بحاجة إلى استخدام معلمة النطاق، فتأكد من تحديد معلمة فارغة أولاً، كما في المثال:

tg_get_command('', scope)

مثال

command = tg_get_command('', 'all_chat_administrators')

قم بتعيين هذه الدالة إلى متغير، وسيحتوي المتغير على استجابة الخادم بالأوامر لنطاق المستخدم المحدد في المعلمة.

{"ok":true,"result":[{"command":"count","description":"إرجاع عدد المستخدمين"},{"command":"unpin","description":"إلغاء تثبيت جميع الرسائل"}]}

إذا تم استدعاء الدالة بدون معلمات، فسيتم تعيين النطاق على 'default'.

command = tg_get_command()

كيفية حذف الأوامر في البوت

tg_delete_command()

لحذف الأوامر

tg_delete_command(language, scope, platform_id, user_id), حيث

المعلمة	الوصف
language	رمز لغة مكون من حرفين وفقًا لـ ISO 639-1، على سبيل المثال 'ru' أو 'en' (معلمة اختيارية؛ إذا لم يتم تحديدها، فسيتم حذف الأوامر المطبقة على جميع المستخدمين ضمن النطاق المحدد الذين ليس لديهم أوامر مخصصة للغتهم).
scope	معلمة تحدد نطاق المستخدمين الذين سيتم حذف الأوامر لهم. إذا لم يتم تحديدها، سيتم تطبيق القيمة الافتراضية 'default'.
platform_id	معرف الدردشة (معلمة اختيارية، تنطبق فقط على قيم محددة لمعلمة النطاق).
user_id	معرف المستخدم (معلمة اختيارية، تنطبق فقط على قيم محددة لمعلمة النطاق).

إذا كنت لا ترغب في استخدام معلمة اللغة ولكنك بحاجة إلى استخدام معلمة النطاق، فتأكد من تحديد قيمة فارغة للمعلمة الأولى، كما في المثال:

tg_delete_command('', scope)

أمر مثل tg_delete_command() سيحذف الأوامر دون تحديد معلمة اللغة، باستخدام قيمة النطاق الافتراضية.

مثال

يمكنك حذف الأوامر المحددة عن طريق استدعاء الدالة مع المعلمات في الآلة الحاسبة:

مثال على الكود للنسخ:

tg_delete_command('', 'all_chat_administrators')

كيفية تكوين ردود الفعل على الأوامر

بالنسبة للأوامر في الدردشة الخاصة مع البوت، تحتاج إلى الرد على رسائل مثل: '/command_name' – حيث command_name هو الأمر.

بالنسبة للأوامر في المجموعات والدردشات، ستظهر الرسائل على النحو التالي: '/command_name@bot_username' – حيث command_name هو الأمر و @bot_username هو اسم مستخدم البوت.

قائمة قيم النطاق:

المعلمة	القيمة
'default'	المعلمة الافتراضية تعني أن الأوامر ستعمل في الرسائل الخاصة مع البوت.
'all_private_chats'	جميع الدردشات الخاصة: الأوامر متاحة للجميع في الدردشات الخاصة التي تمت إضافة البوت إليها.
'all_group_chats'	جميع دردشات المجموعات والمجموعات الفائقة: الأوامر متاحة للجميع في هذه الأنواع من الدردشات التي تمت إضافة البوت إليها.
'all_chat_administrators'	أوامر لمسؤولي جميع دردشات المجموعات والمجموعات الفائقة التي تمت إضافة البوت إليها.
'chat'	أوامر لدردشة محددة (إذا اخترت هذا الخيار، يجب عليك تحديد platform_id).
'chat_administrators'	أوامر لمسؤولي دردشة محددة (إذا اخترت هذا الخيار، يجب عليك تحديد platform_id).
'chat_member'	أوامر لعضو محدد في دردشة معينة (إذا اخترت هذا الخيار، يجب عليك تحديد كل من platform_id و user_id؛ يجب أن يكون المستخدم المحدد عضوًا في الدردشة المحددة).

إذا كنت لا ترغب في استخدام معلمة اللغة ولكنك بحاجة إلى استخدام معلمة النطاق، فتأكد من تحديد قيمة فارغة للمعلمة الأولى، كما في المثال:

tg_delete_command('', scope)