الدوال (API) في الحاسبة
تتوفر وظائف واجهة برمجة التطبيقات فقط في خطط "Business" و"MaviBot AI".
MaviBot API
الأسطورة: ! -المعاملات المطلوبة
كيفية إرسال ردّ نداء
callback()
يمكنك إرسال ردّ نداء إلى عميل آخر فقط.
لا يمكنك إرسال ردّ نداء إلى نفسك!
الوصف
callback(client_id, callback_message)
المعلمات:
! client_id - معرّف العميل
! callback_message - نص رسالة ردّ النداء
مثال
ردّ النداء هو رسالة نظام خاصة يتعرّف عليها الروبوت كأمر لتنفيذ إجراء محدد. هذه الرسالة غير مرئية للمستخدم وتُسجَّل فقط داخل ملف العميل للمعالجة الداخلية.
لنرسل ردّ نداء إلى العميل باستخدام client_id=73704021
بعد ذلك، نضبط الاستجابة لهذا الردّ الندائي في الكتلة مع الشرط.
مثال على الكود للنسخ
callback('73704021', 'callback TEST123')
callback(client_id, 'callback TEST123')كيفية إرسال ردّ نداء في تيليجرام
tg_callback()
الوصف
tg_callback(platform_id , callback_message,group_id, business_connection_id)
المعاملات:
! platform_id - معرّف عميل تيليجرام
! callback_message - نص رسالة ردّ النداء
group_id - معرّف روبوت تيليجرام
tg_business - للاستخدام مع عملاء الأعمال، تُمرَّر القيمة "1".
كيفية إضافة إعادة توجيه للروبوت مع وسم استجابةً لزر ردّ النداء؟
الوصف
tg_callback_url_open(callback_query_id, url)
المعاملات: ! callback_query_id - يتيح لك هذا المعرّف تحديد الشخص الذي ضغط الزر وعرض إشعار تنبيه له، ! url - URL- يحدد الروبوت والمعامل (يظهر بالشكل: t.me/your_bot?start=XXXX، وبدلًا من your_bot - اسم الروبوت)
كيفية إرسال رسالة إلى العميل
message() | platform_message() | whatsapp_message()
لتخزين النص مع فواصل الأسطر في متغير، اضبط القيمة كما يلي:
text = "السطر الأول من النص" + "\n" + "السطر الثاني من النص" + "\n" +"السطر الثالث من النص"
الوصف
message(client_id, text, message_id, timeout)
المعاملات: ! client_id - معرّف العميل ! text - نص الرسالة message_id - معرّف الكتلة. إذا تركت حقل النص فارغًا (") وملأت هذا المعامل، فسيتم إرسال النص من الكتلة المحددة إلى العميل.
ملاحظة: إذا مرّرت المعامل message_id إلى الدالة message، فسيظل تنفيذ الكتلة كاملًا، وسيُنقَل العميل المحدد في المعامل client_id إلى الكتلة التي مررتها في message_id.
timeout - تأخير الرسالة أو وقت الإرسال المجدول. يمكنك استخدام المعامل timeout لتأخير إرسال الرسالة: a) تأخير بالثواني (حتى 3600 ثانية). إذا تجاوزت القيمة 3600، فستُرسل الرسالة بعد ساعة واحدة. إذا كانت القيمة سالبة، فستُرسل الرسالة فورًا. مثال: timeout = 50
b) تاريخ ووقت محددان بالصيغة dd.mm.yyyy hh:mm، مثال: timeout = '03.04.2022 15:00'. إذا تم تحديد تاريخ في الماضي، فستُرسل الرسالة فورًا.
platform_message(platform_id, text, client_type, message_id, timeout,group_id)
المعلمات: ! platform_id - معرّف العميل في المراسِل ! text - نص الرسالة client_type - نوع المراسِل، معامل اختياري. إذا لم يُحدَّد، فسيُبحث عن العميل في المراسِل نفسه الذي يرسل منه الروبوت الرسالة. وإذا تم تحديده، فسيتم العثور على العميل ضمن قاعدة بيانات المراسِل المحدد. يمكنك العثور على أنواع المراسلات هنا. message_id - معرّف الكتلة. إذا تم تحديده، فسيتلقى العميل الرسالة من الكتلة المحددة، وليس القيمة من معامل النص. timeout - وقت الإرسال أو التأخير. وهو مشابه للمعامل الذي يحمل الاسم نفسه في الدالة message(). group_id - معرّف الروبوت
whatsapp_message(phone, text, message_id)
المعلمات: ! phone- رقم هاتف العميل المسجَّل عليه واتساب ! text - نص الرسالة message_id - هو معرّف الكتلة. إذا تُرك حقل النص فارغًا ('') وتم ضبط هذا المعامل، فسيتلقى العميل محتوى الرسالة من الكتلة المحددة.
يجب توصيل روبوت واتساب بالمشروع.
مثال
مثال بسيط على إرسال رسالة باستخدام client_id:
خيارات مختلفة لإرسال رسالة باستخدام client_id:
مثال على إرسال رسالة عبر platform_message():
الحصول على client_id باستخدام قيمة platform_id
get_client_id_by_platform_id()
الوصف
get_client_id_by_platform_id(client_type, platform_id , group)
بعد التنفيذ، ستُرجع الدالة client_id إذا تم العثور على عميل يطابق الشروط المحددة؛ وإلا فستُرجع None.
! client_type - المراسِل. لقيمة client_type اقرأ هذه المقالة.
! platform_id - معرّف العميل في المراسِل المحدد.
group - وهو معامل مطلوب إذا كان أكثر من روبوت مراسِل واحد متصلًا.
إذا كانت عدة مراسلات من النوع نفسه متصلة في المشروع، فسيكون البحث بناءً على جميع المراسلات المتصلة من هذا النوع.
في هذه الحالة، نوصي بتمرير المعامل group.
الدالة لطلبات GET: requests_get(url, answer_type, headers, params, auth, proxy)
الوصف
! url - هو الرابط الذي يتم تقديم الطلب إليه
answer_type – معامل اختياري يحدد ما الذي يجب إرجاعه من استجابة الخادم: ('status' – يعيد رمز حالة الاستجابة؛ 'json' – يعيد جسم JSON للاستجابة؛ 'text' – يعيد النص الخام للاستجابة، وأي قيمة أخرى (بما فيها الافتراضية) تعيد استجابة بالشكل: '{"status": status_code, "data": data}')
headers - معامل اختياري لتمرير ترويسات الطلب،
params - هو get معاملات الطلب (يمكن أيضًا تضمينها مباشرةً في الرابط)،
auth - هو معامل اختياري مفيد لمصادقة واجهة برمجة التطبيقات. إذا كنت لا تريد استخدام أي معامل اختياري لكنك تحتاج إلى التالي، فمرّر 0 هنا.
proxy - هو معامل اختياري؛ يقبل قيمة واحدة: "de"، والتي تمرّر الطلب عبر عنوان IP أوروبي.
دوال لطلبات POST
الوصف
requests_post(url, answer_type, headers, data, json_data, auth, proxy)
! url - هو الرابط الذي يتم تقديم الطلب إليه،
answer_type - هو معامل اختياري يحدد ما الذي يجب إرجاعه من استجابة الخادم: ('status' – يعيد رمز حالة الاستجابة؛ 'json' – يعيد جسم JSON للاستجابة؛ 'text' – يعيد النص الخام للاستجابة، وأي قيمة أخرى (بما فيها الافتراضية) تعيد استجابة بالشكل: '{"status": status_code, "data": data}')
headers - هو معامل اختياري لتمرير ترويسات الطلب
data - هو معامل اختياري؛ ويمثل جسم الطلب عندما لا تعمل الواجهة مع json.
json_data - هو معامل اختياري؛ ويمثل أيضًا جسم الطلب. يجب استخدام أحد هذين المعاملين فقط في كل مرة.
يرجى ملاحظة: قد تمنع بعض إعدادات الترويسات إرسال الطلب بنوع معين من الجسم.
auth - هو معامل اختياري مفيد لمصادقة واجهة برمجة التطبيقات. إذا كنت لا تريد استخدام أي معامل اختياري لكنك تحتاج إلى التالي، فمرّر 0 هنا
proxy - هو معامل اختياري؛ يقبل قيمة واحدة: "de"، والتي تمرّر الطلب عبر عنوان IP أوروبي.
دوال لطلبات PUT
الوصف
requests_put(url, answer_type, headers, data, auth, proxy)
! url - هو الرابط الذي يتم تقديم الطلب إليه
answer_type - هو معامل اختياري يحدد ما الذي يجب إرجاعه من استجابة الخادم: ('status' – يعيد رمز حالة الاستجابة؛ 'json' – يعيد جسم JSON للاستجابة؛ 'text' – يعيد النص الخام للاستجابة، وأي قيمة أخرى (بما فيها الافتراضية) تعيد استجابة بالشكل: '{"status": status_code, "data": data}')
headers - هو معامل اختياري لتمرير ترويسات الطلب
data - هو معامل اختياري؛ ويمثل جسم الطلب عندما لا تعمل الواجهة مع json.
auth - هو معامل اختياري مفيد لمصادقة واجهة برمجة التطبيقات. إذا كنت لا تريد استخدام أي معامل اختياري لكنك تحتاج إلى التالي، فمرّر 0 هنا
proxy - هو معامل اختياري؛ يقبل قيمة واحدة: "de"، والتي تمرّر الطلب عبر عنوان IP أوروبي.
data_is_json هو معامل اختياري.
إذا تم ضبطه، فسيتم إرسال البيانات الممررة في data بصيغة JSON.
لتفعيله، مرّر '1'.
دوال لطلبات PATCH
requests_patch(url, answer_type, headers, data, auth, proxy)
الوصف
! url - هو الرابط الذي يتم تقديم الطلب إليه
answer_type - هو معامل اختياري يحدد ما الذي يجب إرجاعه من استجابة الخادم: ('status' – يعيد رمز حالة الاستجابة؛ 'json' – يعيد جسم JSON للاستجابة؛ 'text' – يعيد النص الخام للاستجابة، وأي قيمة أخرى (بما فيها الافتراضية) تعيد استجابة بالشكل: '{"status": status_code, "data": data}')
headers - هو معامل اختياري لتمرير ترويسات الطلب
data - هو معامل اختياري؛ ويمثل جسم الطلب عندما لا تعمل الواجهة مع json.
auth - هو معامل اختياري مفيد لمصادقة واجهة برمجة التطبيقات. إذا كنت لا تريد استخدام أي معامل اختياري لكنك تحتاج إلى التالي، فمرّر 0 هنا
proxy - هو معامل اختياري؛ يقبل قيمة واحدة: "de"، والتي تمرّر الطلب عبر عنوان IP أوروبي.
دوال لطلبات DELETE
requests_delete(url, answer_type, headers, data, json_data, auth, proxy)
الوصف
! url - هو الرابط الذي يتم تقديم الطلب إليه
answer_type - هو معامل اختياري يحدد ما الذي يجب إرجاعه من استجابة الخادم: ('status' – يعيد رمز حالة الاستجابة؛ 'json' – يعيد جسم JSON للاستجابة؛ 'text' – يعيد النص الخام للاستجابة، وأي قيمة أخرى (بما فيها الافتراضية) تعيد استجابة بالشكل: '{"status": status_code, "data": data}')
headers - هو معامل اختياري لتمرير ترويسات الطلب
data - هو معامل اختياري؛ ويمثل جسم الطلب عندما لا تعمل الواجهة مع json.
json_data - هو اختياري ويمكن استخدامه أيضًا كجسم للطلب. ومع ذلك، يجب استخدام خيار واحد فقط في كل مرة
auth - هو معامل اختياري مفيد لمصادقة واجهة برمجة التطبيقات. إذا كنت لا تريد استخدام أي معامل اختياري لكنك تحتاج إلى التالي، فمرّر 0 هنا
proxy - هو معامل اختياري؛ يقبل قيمة واحدة: "de"، والتي تمرّر الطلب عبر عنوان IP أوروبي.
دالة للحصول على اسم الكتلة حسب معرّفها
آخر تحديث