دوال API متاحة فقط في خطتي "Business" و "MaviBot AI".

API MaviBot

الأسطورة:\ ! - معلمات إلزامية

كيفية إرسال رد اتصال

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('73704021', 'callback TEST123')

tg_callback(platform_id, 'callback TEST123', None, 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 = "First line text" + "\n" + "Second line text" + "\n" +"Third line text"

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*/
message(73704021, 'Message text for client')
/*إرسال رسالة بواسطة client_id مع تأخير 30 ثانية*/
message(73704021, 'Hi! Thanks for writing..','',30)
/*إرسال رسالة من الكتلة 3190 بواسطة client_id في 03.04.2022 الساعة 3 مساءً*/
message(73704021, '',3190, '03.04.2022 3pm')

/*إرسال رسالة في واتساب*/
whatsapp_message('79999999999', 'Message text for the client')

الحصول على 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 (يمكن تضمينها أيضًا مباشرة في URL)،

auth - هو معامل اختياري مفيد لمصادقة API. إذا كنت لا ترغب في استخدام أي معامل اختياري ولكنك بحاجة إلى التالي، فمرر 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 - هو معامل اختياري؛ يمثل نص الطلب عندما لا يعمل API مع json.

json_data - هو معامل اختياري؛ يمثل أيضًا نص الطلب. يجب استخدام واحد فقط من هذه المعاملات في كل مرة.

يرجى ملاحظة: قد تمنع تكوينات رأس معينة إرسال الطلب بنوع معين من النص.

auth - هو معامل اختياري مفيد لمصادقة API. إذا كنت لا ترغب في استخدام أي معامل اختياري ولكنك بحاجة إلى التالي، فمرر 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 - هو معامل اختياري؛ يمثل نص الطلب عندما لا يعمل API مع json.

auth - هو معامل اختياري مفيد لمصادقة API. إذا كنت لا ترغب في استخدام أي معامل اختياري ولكنك بحاجة إلى التالي، فمرر 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 - هو معامل اختياري؛ يمثل نص الطلب عندما لا يعمل API مع json.

auth - هو معامل اختياري مفيد لمصادقة API. إذا كنت لا ترغب في استخدام أي معامل اختياري ولكنك بحاجة إلى التالي، فمرر 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 - هو معامل اختياري؛ يمثل نص الطلب عندما لا يعمل API مع json.

json_data - هو معامل اختياري ويمكن استخدامه أيضًا كنص الطلب. ومع ذلك، يجب استخدام خيار واحد فقط في كل مرة

auth - هو معامل اختياري مفيد لمصادقة API. إذا كنت لا ترغب في استخدام أي معامل اختياري ولكنك بحاجة إلى التالي، فمرر 0 هنا

proxy - هو معامل اختياري؛ يقبل قيمة واحدة: "de"، والتي توجه الطلب عبر عنوان IP أوروبي.

دالة للحصول على اسم الكتلة بواسطة معرفها

get_block_name_by_id(block_id)

! block_id — معرف الكتلة (id)