منشئ API

يمكن تشغيل بعض وظائف طلبات واجهة البرمجة في الحاسبة.

تُرسل الطلبات عبر POST أو GET الطريقة إلى عنوان URL بالتنسيق التالي:

https://chatter.mavibot.ai/api/{api_key}/{action}

حيث:

api_key — مفتاح الوصول إلى واجهة البرمجة المُنشأ في إعدادات المشروع.

لاستخدام الرمز في طلب عبر URL، تحتاج أولًا إلى إنشاء مفتاح API.

تتوفر التعليمات الخاصة بذلك في قسم "إنشاء مفتاح API". رابط

عند نسخ عنوان URL من هذه الصفحة، قد يظهر فراغ ويجب إزالته.

مثال على رابط غير صحيح: https://chatter.mavibot.pro /api/callback

إذا بقي الفراغ بعد .pro فلن يعمل الطلب.

لا تستخدم أحرفًا محظورة عند إرسال طلب GET.

تأكد من فهم التنسيق الصحيح لطلبات GET.

كيفية إنشاء مفتاح API

تظل ميزة إنشاء مفتاح API القديمة تعمل كما كانت، لكنها غير متاحة للمشاريع الجديدة.

إذا كان مشروعك يحتوي بالفعل على مفاتيح API تم إنشاؤها بدون إعدادات الوصول الموصوفة في هذا القسم، فستستمر مفاتيح API الحالية هذه في العمل بشكل طبيعي.

إذا كنت بحاجة إلى إنشاء مفاتيح جديدة، فاستخدم الإعدادات المُحدثة.

لإنشاء مفتاح API، انتقل إلى إعدادات المشروع:

بعد ذلك، انتقل إلى قسم "التكاملات":

ستجد زر "إضافة مفتاح API" في قسم "التكاملات":

بعد النقر على الزر، ستُفتح نافذة منبثقة تحتوي على إعدادات الوصول وخيارات إنشاء مفتاح API:

بعد ذلك، تحتاج إلى تحديد أذونات الوصول لمفتاح API:

ستعمل وظيفة API وفقًا لأذونات الوصول التي تحددها.

يرجى الانتباه!

تعتمد وظيفة API على أذونات الوصول التي تحددها: إذا أنشأت مفتاح API بصلاحية القراءة فقط لمعلومات العميل ثم استخدمته لإرسال رسالة إلى عميل أو تعديل متغيراته، فسيفشل طلب API. يتم تحديد الصلاحية المطلوبة لكل طلب API في بطاقة طلب API:

بعد ذلك، أدخل اسمًا لمفتاح API:

أنشئ مفتاح API بالنقر على زر "إنشاء":

После чего нажмите "Готово" и ключ api добавится в раздел:

يمكنك إضافة عدد غير محدود من مفاتيح API حسب الحاجة، مع تخصيص أذونات وصول مختلفة لكل مفتاح.

بعد ذلك، تحتاج إلى تعيين مفتاح أساسي للمشروع. يتيح لك ذلك استخدام المفتاح في عنوان URL للطلب باستخدام العنصر النائب #{api_key}.

للقيام بذلك، انقر على زر "{+}" الموجود على يمين مفتاح API المطلوب:

ستظهر بعد ذلك تسمية بجانب المفتاح تشير إلى أنه مفتاح المشروع الأساسي.

يمكنك الوصول إلى مفتاح المشروع الأساسي عبر api_key: ما عليك سوى إنشاء المفتاح المطلوب، وتعيين أذوناته، وتحديده كمفتاح المشروع الأساسي. ثم في الحاسبة، استخدم عنوان URL للطلب مع العنصر النائب #{api_key}، والذي سيحتوي على قيمة مفتاح المشروع الأساسي.

URL запроса

أي مفاتيح أخرى تم إنشاؤها مع إعدادات الوصول ستُعتبر مفاتيح ثانوية. في عنوان URL للطلب، يمكنك استخدام قيمتها بدلًا من #{api_key}. للقيام بذلك، انسخ قيمة المفتاح الثانوي:

وألصقها في عنوان URL للطلب بدلًا من #{api_key}:

يتم تعيين مفتاح API المُنشأ بالطريقة القديمة افتراضيًا كمفتاح المشروع الأساسي ويملك جميع الصلاحيات.

ملاحظة!

إذا حذفت المفتاح المُعيَّن كمفتاح المشروع الأساسي، فستحتاج إلى تعيين مفتاح جديد يدويًا كمفتاح أساسي.

يرجى الانتباه!

إذا كانت لديك مفاتيح API تم إنشاؤها بالطريقة القديمة، فستستمر في العمل بشكل طبيعي. لا يمكن إنشاء مفاتيح API جديدة من النوع القديم.

كيفية تلقي الرسائل على عنوان Webhook URL المحدد في إعدادات المشروع

إعدادات المشروع

ستُرسل كل رسالة واردة أو صادرة كطلب JSON POST التالي:

{
    "id": "معرّف الرسالة في النظام",
    "client": {
        "id": "معرّف العميل في النظام",
        "recepient": "معرّف العميل في المراسِل",
        "client_type": "نوع المراسِل",
        "name": "اسم العميل",
        "avatar": "صورة العميل الرمزية",
        "created_at": "تاريخ إنشاء العميل",
        "tag": "مفتاح الاشتراك",
        "group": "البوت المرتبط به العميل"
    },
    "message": "نص الرسالة",
    "attachments": "مصفوفة تحتوي على روابط الملفات أو قواميس روابط الملفات",
    "message_id": "معرّف الكتلة التي أُرسلت منها الرسالة",
    "project_id": "معرّف المشروع",
    "is_input": "1 إذا كانت الرسالة من العميل، 0 إذا كانت من البوت",
    "delivered": "1 إذا أُرسلت الرسالة بنجاح، 0 إذا حدث خطأ",
    "error_message": "نص خطأ تسليم الرسالة"
}

إذا أعاد الطلب خطأ، فلن تتم إعادة المحاولة. وحتى إذا أعاد الخادم أخطاء، ستستمر الإشعارات في الإرسال.

كيفية إنشاء طلب JSON

انتقل إلى إعدادات الكتلة التي ستُسجَّل فيها البيانات في الجدول.

1. أضف قسمًا لطلب API.

2. اختر POST-JSON كنوع الطلب.

3. ثم ابدأ بملء حقول الطلب:

عنوان URL للطلب — المسار إلى الدالة التي سيتم استدعاؤها. في الوثائق، يظهر هذا دائمًا في السطر الأول بجانب نوع الطلب:

القيم المحفوظة — قائمة بمعاملات الاستجابة مع أسماء المتغيرات التي يجب حفظ النتائج فيها، بالتنسيق التالي:

request_parameter -> your_variable

إذا كانت الاستجابة تحتوي على معاملات ذات بنية معقدة، فقم بتحليلها كما يلي:

• "cell_number":{"row":4,"col":2} cell_number|row ->String; cell_number|col -> Column

ترويسات الطلب — املأها إذا لزم الأمر. ويشمل ذلك عادةً تنسيق البيانات و/أو رمز الوصول.

معاملات JSON — جسم الطلب، حيث تحدد معلمات البيانات بصيغة JSON. مثال:

{"client_id": "#{recipient_id_in_builder}", "message":"Hello!"}

لفهم بنية الاستجابة، اكتب #{custom_answer} في حقل Message لإخراج قيمة المتغير.

استلام نتيجة طلب API كرسالة

بعد ذلك، تسرد الوثائق المعاملات المسموح بها في قسم "Body":

كيفية استخدام webhook عام

يمكن الآن تنفيذ الطرق المدرجة إما كطلبات POST أو GET.

• callback

• whatsapp_callback

• message

• whatsapp_message

في السابق، كانت طرقنا تحتوي على معاملات ثابتة (مثل client_id و fb_idلتفعيل إجراءات المشتركين، مما فرض بعض القيود عند التكامل مع خدمات الطرف الثالث.

يمكنك الآن تحديد معامل الطلب الذي يجب أن يستخدمه SaleBot للعثور على معرّف المستخدم. استخدم معاملًا يبدأ بـ بادئة value_، على سبيل المثال، value_user_id أو value_group_id.

بالإضافة إلى ذلك، يمكن الآن تشغيل طريقة إرسال callback باستخدام البريد الإلكتروني للعميل (client_email) أو رقم الهاتف (client_phone).

الـ callback, fb_callback، و whatsapp_callback لا ترتبط الطرق بأسماء معاملات محددة. يمكنك تحديد أي معامل يحتوي على رقم هاتف العميل أو البريد الإلكتروني أو المعرّف.

هذا مفيد عند إعداد استقبال webhook من موقع ويب.

لتحديد المتغير الذي يحتوي على client_id، استخدم المعامل value_client_id وقدم اسم المعامل الذي يحمل هذه القيمة.

لتحديد المتغير الذي يحتوي على رقم الهاتف، استخدم value_phone.

لتحديد المتغير الذي يحتوي على البريد الإلكتروني، استخدم value_email.

لتحديد المتغير الذي يحتوي على user_id، استخدم value_user_id.

لتحديد المتغير الذي يحتوي على group_id، استخدم value_group_id.

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

مثال:

في العنوان، حدِّد value_client_id = my_client.

https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback?value_client_id=my_client {"my_client":49177759, "message":"Hello world"}

سيكون الطلب مكافئًا لما يلي:

https://chatter.mavibot.pro/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback {"client_id":49177759, "message":"Hello world"}

كما ترى، فإن اسم المعامل الذي يحتوي على القيمة يسبقه value_.

يرجى الانتباه!

تُنشئ بعض الأحداث إشعارات نظام داخل المشروع.

على سبيل المثال، توجد إشعارات نظام تحتوي على حقل رسالة غير فارغ ولكنها لا تتضمن نص العميل.

وفي الوقت نفسه، قد يُنشئ المشروع أيضًا webhooks للرسائل بمحتوى محدد، مثل "message: new_chat_member".

لذلك، من المهم التحقق من المحتوى: فإما أن يكون إشعارًا نظاميًا أو webhook لحدث محدد.

كيفية تشغيل البوت

تشغيل البوت

POST https://chatter.mavibot.ai/api/#{api_key}/callback

URL запроса: https://chatter.mavibot.ai/api/#{api_key}/callback

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

يرجى ملاحظة: سيتم حفظ أي معاملات تمررها أيضًا في المتغير

يمكن الآن أيضًا تشغيل طريقة callback باستخدام البريد الإلكتروني للعميل (client_email) أو رقم الهاتف (client_phone).

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل/حذف معلومات العميل".

المسار

api key* - رمز الوصول

Body

client_phone - رقم الهاتف المستخدم للبحث عن العميل

client_email - البريد الإلكتروني المستخدم للبحث عن العميل

client_id - معرّف العميل في الباني

message - نص الرسالة

resume_bot - True (معامل اختياري). إذا كان البوت متوقفًا مؤقتًا، يُستخدم هذا لإعادة تشغيله.

مثال: resume_bot = True

time_shift - رقم. إذا تم تحديده، فستُرسل الرسالة بعد عدد الثواني المحدد من الوقت الحالي.

send_time - التاريخ والوقت بالتنسيق "%Y-%m-%d %H:%M:%S" (مثال: "2024-10-16 13:15:59"). هذا يحدد التاريخ والوقت لإرسال الرسالة. إذا تم تحديد كل من time_shift وsend_time، فستكون الأولوية لـ time_shift.

import requests
import json

params = {"message": "some_text", "client_id": "25554"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.salebot.pro/api/{token}/callback'
requests.post(url, json=params)

بدء تشغيل البوت باستخدام رقم WhatsApp

POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_callback

URL request: https://chatter.mavibot.ai/api/<api_key>/whatsapp_callback

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

يرجى ملاحظة: سيتم حفظ أي معاملات تمررها أيضًا في المتغير

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل أو حذف معلومات العميل".

المسار

api key* - رمز الوصول

Body

name - اسم العميل message - نص الرسالة phone - رقم هاتف العميل bot_id - معرّف البوت resume_bot - True (معامل اختياري). إذا كان البوت متوقفًا مؤقتًا، فاستخدم هذا لاستئنافه. مثال: resume_bot = True

time_shift - رقم. إذا تم تحديده، فستُرسل الرسالة بعد عدد الثواني المحدد من الوقت الحالي.

send_time - التاريخ والوقت بالتنسيق "%Y-%m-%d %H:%M:%S" (مثال: "2024-10-16 13:15:59"). هذا يحدد التاريخ والوقت لإرسال الرسالة. إذا تم تحديد كل من time_shift وsend_time، فستكون الأولوية لـ time_shift.

بدء تشغيل البوت باستخدام معرّف Telegram

POST https://chatter.mavibot.pro/api/#{api_key}/tg_callback

URL request: https://chatter.mavibot.pro/api/#{api_key}/tg_callback

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

يرجى ملاحظة: سيتم حفظ أي معاملات تمررها أيضًا في المتغيرات.

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل أو حذف معلومات العميل".

المسار

api key* - رمز الوصول

Body

message - نص الرسالة user_id - معرّف مستخدم Telegram group_id - اسم البوت (ينتهي بـ bot) resume_bot - True (معامل اختياري). إذا كان البوت متوقفًا مؤقتًا، فاستخدم هذا لاستئنافه. مثال: resume_bot = True

time_shift - رقم. إذا تم تحديده، فستُرسل الرسالة بعد عدد الثواني المحدد من الوقت الحالي.

send_time - التاريخ والوقت بالتنسيق "%Y-%m-%d %H:%M:%S" (مثال: "2024-10-16 13:15:59"). هذا يحدد التاريخ والوقت لإرسال الرسالة. إذا تم تحديد كل من time_shift وsend_time، فستكون الأولوية لـ time_shift.

إرسال رسائل callback إلى قائمة عملاء حسب platform_id

POST https://chatter.mavibot.ai/api/#{api_key}/send_callback_by_platform_id

URL request: https://chatter.mavibot.ai/api/#{api_key}/send_callback_by_platform_id

عندما يتم العثور على عملاء لديهم platform_id من القائمة داخل المشروع، سيتم إرسال callback بالنص الموجود في حقل callback_text. الحد: طلب واحد = بحد أقصى 300 إرسال

مثال على معلمات الطلب: {"platform_ids":[407184121, "79609879898", "2rwewefw"], "callback_text": "test_callback"}

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل أو حذف معلومات العميل".

المسار

api key* - رمز الوصول

Body

platform_ids - قائمة معرّفات العملاء في المراسِل callback_text - نص callback group_id - معرّف البوت

time_shift - رقم. إذا تم تحديده، فستُرسل الرسالة بعد عدد الثواني المحدد من الوقت الحالي.

send_time - التاريخ والوقت بالتنسيق "%Y-%m-%d %H:%M:%S" (مثال: "2024-10-16 13:15:59"). هذا يحدد التاريخ والوقت لإرسال الرسالة. إذا تم تحديد كل من time_shift وsend_time، فستكون الأولوية لـ time_shift.

إرسال رسالة callback إلى عميل عبر البريد الإلكتروني

POST https://chatter.mavibot.ai/api/#{api_key}/email_callback

URL request: https://chatter.mavibot.ai/api/#{api_key}/email_callback

يمكن لهذه الطريقة تشغيل بوت البريد الإلكتروني بعد تسجيل العميل على الموقع أو تقديم طلب باستخدام بريده الإلكتروني. ستعثر الطريقة على بريد العميل الإلكتروني أو تنشئه إذا لم يكن موجودًا.

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل أو حذف معلومات العميل".

يرجى ملاحظة: سيتم حفظ أي معاملات تمررها أيضًا في المتغير

المسار

api key* - رمز الوصول

Body

name - اسم العميل message - نص الرسالة email - عنوان البريد الإلكتروني email_id_bot - عنوان بريد البوت الإلكتروني resume_bot - True (معامل اختياري).

إذا كان البوت متوقفًا مؤقتًا، فاستخدم هذا لاستئنافه. مثال: resume_bot = True

time_shift - رقم. إذا تم تحديده، فستُرسل الرسالة بعد عدد الثواني المحدد من الوقت الحالي.

send_time - التاريخ والوقت بالتنسيق "%Y-%m-%d %H:%M:%S" (مثال: "2024-10-16 13:15:59"). هذا يحدد التاريخ والوقت لإرسال الرسالة. إذا تم تحديد كل من time_shift وsend_time، فستكون الأولوية لـ time_shift.

كيفية العمل مع الرسائل

معلمات إرسال الرسالة

attachment_type — يمكن أن يكون: صورة، فيديو، رابط، ملف، أو صوت. عند إرسال مرفق، يكون معامل الرسالة اختياريًا.

buttons — يحدد الأزرار التي ستُرفق بالرسالة. يتوافق تنسيق الأزرار مع إعدادات الأزرار المتقدمة.

يمكن تمرير الأزرار بطريقتين: مع تلميح للمراسلات التي لا تدعم الأزرار، أو بدونه.

مثال على معامل الأزرار:

"buttons": {
  "hint": "سيتم عرض هذا النص في WhatsApp",
  "buttons": [
    {
      "type": "reply",
      "text": "أخبرني عن الخدمات",
      "line": 0,
      "index_in_line": 0
    },
    {
      "type": "reply",
      "text": "أسعار الخدمات",
      "line": 0,
      "index_in_line": 1
    },
    {
      "type": "reply",
      "text": "جهات الاتصال",
      "line": 1,
      "index_in_line": 0
    },
    {
      "type": "reply",
      "text": "إرسال طلب",
      "line": 1,
      "index_in_line": 1
    }
  ]
}

إرسال رسالة إلى عميل

POST https://chatter.mavibot.ai/api/#{api_key}/message

URL запроса: https://chatter.mavibot.ai/api/#{api_key}/message

يمكن استخدام هذه الطريقة لإرسال رسائل إشعار. معامل message مطلوب إلا إذا كنت ترسل ملفًا. إذا كنت ترسل ملفًا، فالنص اختياري.

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل أو حذف معلومات العميل".

المسار

api key* - رمز الوصول

Body

message_id - رقم الكتلة للإرسال message - نص الرسالة client_id - معرّف العميل في الباني attachment_type - نوع عرض الملف. مطلوب إذا تم توفير attachment_url. attachment_url - رابط الملف buttons - الأزرار

time_shift - رقم. إذا تم تحديده، فستُرسل الرسالة بعد عدد الثواني المحدد من الوقت الحالي.

send_time - التاريخ والوقت بالتنسيق "%Y-%m-%d %H:%M:%S" (مثال: "2024-10-16 13:15:59"). هذا يحدد التاريخ والوقت لإرسال الرسالة. إذا تم تحديد كل من time_shift وsend_time، فستكون الأولوية لـ time_shift.

import requests
import json

# إرسال رسالة نصية
params = {"message": "some_text", "client_id": "25554"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/message'
requests.post(url, json=params)

# إرسال مرفق
params = {
    "message": "some message",
    "client_id": "1234565",
    "attachment_type": "video/image/file",
    "attachment_url": "https://qwreqw"
}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/message'
requests.post(url, json=params)

# في 'attachment_type'، حدّد إما 'video' أو 'image' أو 'file'
# حسب نوع المرفق: فيديو أو صورة أو مستند.

إرسال رسالة في WhatsApp

POST https://chatter.salebot.pro/api/<api_key>/whatsapp_message

URL запроса: https://chatter.mavibot.pro/api/<api_key>/whatsapp_message

يتيح لك إرسال رسالة باسم البوت المتصل إلى الرقم المحدد. يجب أخذ whatsapp_bot_id من قسم "المراسِلات والدردشات". يتم تعيين معرّف فريد لكل حساب WhatsApp متصل بواسطة الباني.

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل أو حذف معلومات العميل".

المسار

api key* - رمز الوصول

Body

message_id - رقم الكتلة للإرسال whatsapp_bot_id - معرّف بوت WhatsApp الذي يجب إرسال الرسالة من خلاله attachment_url - رابط الملف attachment_type - نوع عرض الملف. مطلوب إذا تم توفير attachment_url. message - نص الرسالة phone - رقم هاتف المستلم

time_shift - رقم. إذا تم تحديده، فستُرسل الرسالة بعد عدد الثواني المحدد من الوقت الحالي.

send_time - التاريخ والوقت بالتنسيق "%Y-%m-%d %H:%M:%S" (مثال: "2024-10-16 13:15:59"). هذا يحدد التاريخ والوقت لإرسال الرسالة. إذا تم تحديد كل من time_shift وsend_time، فستكون الأولوية لـ time_shift.

import requests
import json

params = {"message": "some_text", "phone": "79875146788"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/whatsapp_message'
requests.post(url, json=params)

إرسال رسائل جماعية

POST https://chatter.mavibot.ai/api/#{api_key}/broadcast

URL request: https://chatter.mavibot.ai/api/#{api_key}/broadcast

تتيح لك هذه الطريقة بدء بث جماعي.

يمكنك استخدام أحد الخيارات التالية المتبادلة حصريًا:

1. معامل list — سيتم إرسال البث إلى القائمة المحددة من العملاء.

2. معامل clients — سيتم إرسال البث إلى مصفوفة من معرّفات العملاء.

3. معاملات platform_ids وgroup_id — سيتم إرسال البث إلى مصفوفة من platform_ids (معرّفات المراسِل) للبوت المحدد (group_id).

4. إذا لم يتم توفير أي من المعاملات المذكورة أعلاه، فلن يتم إرسال البث.

المعاملات المطلوبة: message (و/أو attachment_type وattachment_url) أو message_id.

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل أو حذف معلومات العميل".

المسار

api key* - رمز الوصول

Body

list - رقم القائمة التي يجب إرسال البث إليها

clients - معرّفات العملاء في الباني

message - نص الرسالة

platform_ids - معرّفات المستلمين في المراسِل. يجب استخدامها مع المعامل المطلوب group_id

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

attachment_url - رابط الملف

attachment_type - نوع عرض الملف. مطلوب إذا تم توفير attachment_url.

buttons - الأزرار

message_id - رقم الكتلة للإرسال

shift — عدد الثواني بين الرسائل. القيمة الافتراضية هي 0.2.

time_shift - رقم. إذا تم تحديده، فستُرسل الرسالة بعد عدد الثواني المحدد من الوقت الحالي.

send_time - التاريخ والوقت بالتنسيق "%Y-%m-%d %H:%M:%S" (مثال: "2024-10-16 13:15:59"). هذا يحدد التاريخ والوقت لإرسال الرسالة. إذا تم تحديد كل من time_shift وsend_time، فستكون الأولوية لـ time_shift.

import requests
import json

params = {"message": "some_text", "clients": ["5", "58", "110"]}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/broadcast'
requests.post(url, json=params)

استرجاع سجل الرسائل

GET https://chatter.mavibot.ai/api/#{api_key}/get_history?client_id=

URL request: https://chatter.mavibot.ai/api/#{api_key}/get_history?client_id=

يمكن الحصول على معامل client_id هنا. رابط

صلاحية الوصول عند إنشاء المفتاح: "صلاحية قراءة معلومات العميل".

المسار

api key* - رمز الوصول

Body

client_id - معرّف العميل

limit - عدد العناصر في الاستجابة. الافتراضي: 2000، الحد الأقصى: 2000

start_date - تاريخ بداية فترة الاختيار (مطلوب إذا تم تحديد stop_date)، الصيغة: dd.mm.yyyy

stop_date - تاريخ نهاية فترة الاختيار (مطلوب إذا تم تحديد start_date)، الصيغة: dd.mm.yyyy

{
  "status": "success",
  "result": [
    {
      "id": 104500,
      "answered": true,
      "client_replica": false,
      "message_id": 390,
      "message_from_outside": 0,
      "created_at": 1587895014,
      "text": "Meow meow",
      "attachments": {
        
      },
      "delivered": true,
      "error_message": "true",
      "manager_id": 12486,
      "manager_email": "[email protected]"
    },
  ]
}

مسح سجل الرسائل

GET https://chatter.mavibot.ai/api/#{api_key}/clear_history?client_id=

URL запроса: https://chatter.mavibot.ai/api/#{api_key}/clear_history?client_id=

يحذف سجل الدردشة

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل/حذف معلومات العميل".

المسار

api key* - رمز الوصول

Body

client_id - معرّف العميل

import requests
import json


token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/clear_history?client_id=85856'
requests.get(url)

كيفية إسناد العملاء

إسناد عميل إلى موظف

POST https://chatter.mavibot.ai/api/#{api_key}/assign_to_user

URL request: https://chatter.mavibot.ai/api/#{api_key}/assign_to_user

تتيح لك هذه الطريقة إسناد عميل إلى موظف. معامل email اختياري. إذا لم يتم توفير بريد إلكتروني، فسيقوم النظام بإسناد العميل وفقًا لخوارزميته.

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل/حذف معلومات العميل".

المسار

api key* - رمز الوصول

Body

client_id - معرّف العميل email - بريد الموظف الإلكتروني (اختياري)

import requests
import json

params = {"client_id":"#{client_id}","email":"[email protected]"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/broadcast'
requests.post(url, json=params)

استيراد العملاء إلى النظام

POST https://chatter.mavibot.ai/api/#{api_key}/load_clients

URL request: https://chatter.mavibot.pro/api/#{api_key}/load_clients

تتيح لك هذه الطريقة استيراد العملاء إلى النظام. عند رفع عملاء WhatsApp، يمكنك إدخال الرقم بأي تنسيق، سواء مع اللاحقة @s.whatsapp.net أو بدونها.

يمكن الحصول على معرّف المجموعة (group_id) هنا عبر /api/<api_key>/connected_channels. (إذا كان client_type = 13 (الهاتف)، فإن group_id يكون سلسلة فارغة: ""). رابط

يمكن العثور على نوع المراسِل الذي جاء منه العميل (client_type) هنا. رابط

مثال: [{"platform_id":"79875555555","group_id":34810,"client_type":6}]

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل أو حذف معلومات العميل".

المسار

api key* - رمز الوصول

Body

platform_id - رقم الهاتف group_id - معرّف المجموعة client_type - نوع المراسِل الذي جاء منه العميل

import requests
import json
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/load_clients'
params = [{ "platform_id": 274827917, "group_id": 169166236, "client_type":0},
{"platform_id":"[email protected]", "group_id": "1hwF7lwEjv4SKYIGFhQnBw==", "client_type": 6}]
requests.post(url, json=params)
# إذا نجحت العملية، ستُرجع الدالة معرّفًا وحالة إضافة لكل عنصر
# مثال على الاستجابة
# {"status":"success","items":[{"platform_id":"[email protected]","group_id":"5kqchxwyvdvFZOsp80q2qw==","client_type":6,"status":"success","id":1469409}]}

إضافة العملاء إلى قائمة

POST https://chatter.mavibot.ai/api/<api_key>/add_to_list

URL request: https://chatter.mavibot.ai/api/<api_key>/add_to_list

يضيف العملاء إلى قائمة

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل أو حذف معلومات العميل".

المسار

api key* - رمز الوصول

Body

list_id - رقم القائمة clients - مصفوفة معرّفات العملاء

مثال: JSON parameters {"list_id":1170282, "clients":[411262772, 646410963]}

إزالة العملاء من قائمة

POST https://chatter.mavibot.ai/api/#{api_key}/remove_from_list

URL request: https://chatter.mavibot.ai/api/#{api_key}/remove_from_list

يزيل العملاء من قائمة

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل أو حذف معلومات العميل".

المسار

api key* - رمز الوصول

Body

list_id - رقم القائمة clients - مصفوفة أرقام العملاء في باني Mavibot (قيم client_id)

استرجاع قائمة العملاء

GET https://chatter.mavibot.ai/api/<api_key>/get_clients

URL request: https://chatter.mavibot.a/aipi/<api_key>/get_clients

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل أو حذف معلومات العميل".

المسار

api key* - رمز الوصول

Body

offset – الإزاحة من العنصر الأول

limit – عدد العناصر في الاستجابة / الافتراضي: 500، الحد الأقصى: 500

list – رقم القائمة

reverse – يشير إلى الترتيب العكسي (من أقدم سجل إلى أحدث سجل). يعمل هذا المعامل فقط إذا لم يتم تحديد القائمة.

يعيد الحالة ومصفوفة من العناصر.

{
"status":"success",
"clients":[{
    "id":44483,
    "platform_id":"146467928",
    "client_type":0,
    "name":null,
    "avatar":null,
    "message_id":null,
    "project_id":1,
    "created_at":1588248599,
    "updated_at":1588248599,
    "custom_answer":null,
    "tag":null,
    "group":"143414131",
    "operator_start_dialog":null
    }
]
}

استرجاع قائمة مشتركي البوت في أي مراسل

GET https://chatter.mavibot.ai/api/#{api_key}/subscribers

URL request: https://chatter.mavibot.ai/api/#{api_key}/subscribers

يسترجع معلومات العملاء من مراسل محدد.

ملاحظة! لا تعيد هذه الطريقة المتغيرات.

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل أو حذف معلومات العميل".

المسار

api key* - رمز الوصول

Body

page tag – الوسم المحدد في صفحة الاشتراك group – معرّف مجموعة VK المرتبط بها المشترك date_from – تم الاشتراك بعد هذا التاريخ (طابع زمني) date_to – تم الاشتراك قبل هذا التاريخ (طابع زمني) client_type – معرّف المراسِل الذي سيتم استرجاع قائمة المشتركين له. إذا لم يتم تحديده، فسيتم إرجاع جميع العملاء

[  
  {
    "id": 44886,
    "tag": null,
    "created_at": 1609867984,
    "name": "John Smith",
    "vk_id": "146467928",
    "group": "155824294",
    "variables": null
  },
  {
    "id": 44889,
    "tag": null,
    "created_at": 1609867984,
    "name": "Anna Smith",
    "vk_id": "1609867984",
    "group": "155824294",
    "variables": {
      "utm_source": "some_value"
    }
  }
]

كيفية العمل مع المتغيرات

تعيين المتغيرات

POST https://chatter.mavibot.ai/api/#{api_key}/save_variables

URL request: https://chatter.mavibot.ai/api/#{api_key}/save_variables

! لا ينطبق أي حد على هذا الطلب.

يتيح لك حفظ المتغيرات في كل من الصفقة والعميل. افتراضيًا، يضيف طلب تعيين المتغيرات هذه المتغيرات إلى متغيرات الصفقة. لتحديث المتغيرات في ملف العميل، استخدم البادئة client.. على سبيل المثال، للهاتف: client.phone.

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل أو حذف معلومات العميل".

تحديث: تتيح لك معلمة clients تعيين المتغيرات دفعة واحدة. مثال: {"client_id":49177759, "variables":{"client.phone":"88888888888"}}

المسار

api key* - رمز الوصول

Body

clients – مصفوفة من معرّفات العملاء لتعيين المتغيرات

client_id – معرّف العميل

variables – تجزئة المتغيرات (أزواج مفتاح-قيمة)

import requests
import json

params = {"client_id": "25554", "variables": {"var_name": "var_value"}}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/save_variables'
requests.post(url, json=params)

استرجاع المتغيرات

GET https://chatter.mavibot.ai/api/#{api_key}/get_variables?client_id=

URL request: https://chatter.mavibot.ai/api/#{api_key}/get_variables?client_id=

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل أو حذف معلومات العميل".

مثال: https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/get_variables?client_id=49177759

المسار

api key* - رمز الوصول

Body

client_id - معرّف العميل

import requests
import json


token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/get_variables?client_id=85856'
requests.get(url)

كيفية استرجاع معرّف العميل (client_id)

استرجاع client_id باستخدام قيمة platform_id

POST https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_platform_id

URL request: https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_platform_id

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل أو حذف معلومات العميل".

المسار

api key* - رمز الوصول

Body

platform_ids - مصفوفة المعرّفات في المراسِل group_id - معرّف البوت

[{
"id":15099119,
"tag":null,
"created_at":1618815253,
"name":"ОЛЬГА БЕЛИК",
"avatar":"https:\\/\\/files.mavibot.ai\\/uploads\\/avatars\\/256865200.jpg",
"platform_id":"2568652",
"group":"Mavibotai_bot",
"variables":{"tg_username":"@belik"}},

{"id":21087377,
"tag":null,
"created_at":1626275893,
"name":"John Smith",
"avatar":"https:\\/\\/files.mavibot.ai\\/uploads\\/avatars\\/571830542.jpg",
"platform_id":"571830542",
"group":"Mavibotai_bot",
"variables":{"tg_username":"@jsmith61"}
}]

استرجاع معرّف العميل من الدردشة المباشرة

GET https://chatter.mavibot.ai/api/#{api_key}/online_chat_client_id?recipient=

URL request: https://chatter.mavibot.ai/api/#{api_key}/online_chat_client_id?recipient=

تتيح لك هذه الطريقة دمج موقع ويب مع روبوت دردشة. على سبيل المثال، إذا زار مستخدم صفحة ترويجية، يمكنك فورًا إرسال رسالة في الدردشة مع عرض مخصص.

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل أو حذف معلومات العميل".

المسار

api key* - رمز الوصول

Body

tag - الوسم (وسم العميل) name - اسم العميل recipient - معرّف الحوار على موقع ويب

من أين تحصل على recipient؟

يمكنك الحصول عليه على الموقع الذي يحتوي على الدردشة المباشرة من Mavibot.ai، استخدم JS للحصول على الخاصية MavibotAi.recipient_id.

{ "client_id": 36553 }

استرجاع client_id بواسطة رقم WhatsApp

GET https://chatter.mavibot.ai/api/#{api_key}/whatsapp_client_id?phone=

URL request: https://chatter.mavibot.ai/api/#{api_key}/whatsapp_client_id?phone=

تعيد هذه الطريقة معرّف العميل لإجراء طلبات API إذا كنت تعرف رقم WhatsApp الخاص بالعميل. إذا لم يوجد عميل بهذا الرقم، فستعيد الطريقة خطأ 404.

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل أو حذف معلومات العميل".

المسار

api key* - رمز الوصول

Body

phone - رقم الهاتف group_id - معرّف البوت

استرجاع client_id بواسطة رقم الهاتف

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_phone?phone=

URL request: https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_phone?phone=

تعيد هذه الطريقة معرّف العميل لإجراء طلبات API.

يتم البحث سواءً بين عملاء واتساب أو عبر المتغيرات.

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل أو حذف معلومات العميل".

المسار

api key* - رمز الوصول

Body

phone - رقم الهاتف

استرجاع client_id حسب البريد الإلكتروني

GET https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_email?email=

عنوان طلب URL: https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_email?email=

تعيد هذه الطريقة معرّف العميل لإجراء طلبات API. يتم البحث باستخدام المتغيرات.

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل أو حذف معلومات العميل".

المسار

api key* - رمز الوصول

Body

email - البريد الإلكتروني للبحث

استرجاع client_id حسب قيمة المتغير

GET https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_var?var=&val=

عنوان طلب URL: https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_var?var=&val=

تعيد هذه الطريقة معرّف العميل لإجراء طلبات API.

صلاحية الوصول عند إنشاء المفتاح: "صلاحية قراءة معلومات العميل"

المسار

api key* - رمز الوصول

Body

var - اسم المتغير الذي سيتم البحث به val - قيمة المتغير group_id - معرّف المجموعة search_in - مرِّر القيمة 'order' للبحث في متغيرات الصفقة؛ يبحث حتى ثلاث متغيرات لعملاء المشروع ويعيد قائمة بالعملاء الذين لديهم جميع المتغيرات المحددة.

استرجاع معرّف أحدث عميل تم إنشاؤه حسب قيمة المتغير

GET https://chatter.mavibot.ai/api/#{api_key}/find_latest_client_id_by_var?var=&val=

عنوان طلب URL: https://chatter.mavibot.ai/api/#{api_key}/find_latest_client_id_by_var ?var=&val=

تعيد هذه الطريقة معرّف أحدث عميل تم إنشاؤه لإجراء طلبات API. وهي تبحث في متغيرات العميل والصفقة معًا.

صلاحية الوصول عند إنشاء المفتاح: "صلاحية قراءة معلومات العميل"

المسار

api key* - رمز الوصول

Body

var - اسم المتغير الذي سيتم البحث به val - قيمة المتغير

استرجاع قائمة بقيم client_id حسب قيمة المتغير

GET https://chatter.mavibot.ai/api/#{api_key}/find_all_client_id_by_var?var=&val=

عنوان طلب URL: https://chatter.mavibot.ai/api/#{api_key}/find_all_client_id_by_var?var=&val=

تعيد هذه الطريقة قائمة بمعرّفات العملاء الذين لديهم المتغير المحدد بالقيمة المحددة.

صلاحية الوصول عند إنشاء المفتاح: "صلاحية قراءة معلومات العميل"

المسار

api key* - رمز الوصول

Body

var - اسم المتغير الذي سيتم البحث به val - قيمة المتغير

{
    // الاستجابة
}

استرجاع قائمة بقيم client_id بناءً على عدة قيم لمتغيرات مختلفة

GET https://chatter.mavibot.ai/api/#{api_key}/find_all_client_id_by_several_vars?var=val

عنوان طلب URL: https://chatter.mavibot.ai/api/#{api_key}/find_all_client_id_by_several_vars?var=val

صلاحية الوصول عند إنشاء المفتاح: "صلاحية قراءة معلومات العميل".

المسار

api key* - رمز الوصول

Body

variable1 - القيمة1

variable2 - القيمة2

variable3 - القيمة3

{
 "status":"success","client_ids":[93891114]
}

البحث حسب المتغيرات

POST https://chatter.mavibot.ai/api/#{api_key}/find_clients

عنوان طلب URL: https://chatter.mavibot.ai/api/#{api_key}/find_clients

تبحث هذه الطريقة حسب المتغيرات وتعيد قائمة بمعرّفات العملاء الذين يطابقون شروط الاستعلام.

افتراضيًا، يتم البحث في متغيرات العميل (مُوصى به): {"q": {"result": "ok", "var": "home", "var": "60"}} – يجب أن يمتلك العميل جميع المتغيرات المحددة

البحث في متغيرات الصفقة، يجب أن يكون أحد المتغيرات المحددة موجودًا على الأقل: {"q": {"result": "ok", "var": "home", "var": "60"}, "search_in": "order", "include_all": False}

اسم متغير العميل يساوي إحدى قيم القائمة: {"q": {"name": {"_in": ["Joe", "Jane", "Donald"]}}}

اسم متغير العميل لا يساوي أيًّا من قيم القائمة: {"q": {"name": {"_not_in": ["Joe", "Jane", "Donald"]}}}

اسم متغير العميل لا يساوي "Joe": {"q": {"name": {"_not": "Joe"}}}

ملاحظة: تعمل مقارنة الأرقام فقط إذا كانت جميع العملاء لديهم قيم رقمية في المتغير المطلوب البحث فيه. إذا كان لدى عميل واحد فقط قيمة نصية، فسيفشل الطلب.

صلاحية الوصول عند إنشاء المفتاح: "صلاحية قراءة معلومات العميل"

المعلمات

المسار

api key* - رمز الوصول

Body

q – معلمة مطلوبة، تحتوي على شروط الاستعلام للبحث في المتغيرات

search_in – يحدد متغيرات أي كيان سيتم البحث فيها؛ إذا لم يُحدَّد، فسيتم البحث في متغيرات العميل. يمكن أن يأخذ القيمة order.

include_all – هل يجب استيفاء جميع الشروط في q؛

False – إذا تطابق شرط واحد على الأقل، يتم اختيار الكيان

نجاح
{"status":"success","client_ids":[41203, 5622354, 785212]} 
{"status":"success","client_ids":[]} 
{"status": "fail", "message": "Parameter "q" required"} {"status": "fail", "message": "Error in parameter format"}
خطأ
{"status":"fail","message":"Something went wrong"}

كيفية التعامل مع الصفقات

استرجاع معرّف الصفقة الحالية

GET https://chatter.mavibot.ai/api/#{api_key}/get_current_order_id

URL request: https://chatter.mavibot.ai/api/#{api_key}/get_current_order_id

صلاحية الوصول عند إنشاء المفتاح: "صلاحية قراءة معلومات CRM".

المسار

api key* - رمز الوصول

Body

client_id - معرّف العميل

استجابة ناجحة: {"status":"success","order_id":40632}، حيث
order_id - معرّف الصفقة الحالية
استجابة خطأ: {"status":"client_not_found"}

استرجاع قائمة الصفقات

GET https://chatter.mavibot.ai/api/#{api_key}/get_orders

URL request: https://chatter.mavibot.ai/api/#{api_key}/get_orders

صلاحية الوصول عند إنشاء المفتاح: "صلاحية قراءة معلومات CRM"

المسار

api key* - رمز الوصول

Body

client_id - معرّف العميل

order_status - مرحلة الصفقة: 0 - الصفقات النشطة 1 - الصفقات الناجحة 2 - الصفقات غير الناجحة

استجابة ناجحة: {"status":"success","order_id":[40338,40340,40341]} 
استجابة خطأ: {"status":"client_not_found"}

نقل صفقة إلى المرحلة التالية في مسار Mavibot

POST https://chatter.mavibot.ai/api/#{api_key}/move_order_to_next_state

URL request: https://chatter.mavibot.ai/api/#{api_key}/move_order_to_next_state

صلاحية الوصول عند إنشاء المفتاح: "صلاحية تعديل/حذف معلومات CRM"

المسار

api key* - رمز الوصول

Body

client_id - معرّف العميل

order_id - معرّف الصفقة

استجابة ناجحة: 
{"status":"success","state_id":37}، حيث 
state_id - معرّف المرحلة في MavibotCRM 
استجابة خطأ: 
{"status":"client_not_found"}

استرجاع بيانات الصفقة

POST https://chatter.mavibot.ai/api/#{api_key}/get_order_vars

URL request: https://chatter.mavibot.ai/api/#{api_key}/get_order_vars

صلاحية الوصول عند إنشاء المفتاح: "صلاحية قراءة معلومات CRM"

المسار

api key* - رمز الوصول

Body

client_id - معرّف العميل

order_id - معرّف الصفقة

variables - مصفوفة المتغيرات (الصيغة:["var_name1", "var_name2"])

استجابة ناجحة: 
{"status":"success","result":{"var_name1":"111","var_name2":"13.04.2023"}} 

مثال على خطأ: 
{"status":"client_not_found"}

إضافة متغيرات الصفقة

POST https://chatter.mavibot.ai/api/#{api_key}/set_order_vars

URL request: https://chatter.mavibot.ai/api/#{api_key}/set_order_vars

صلاحية الوصول عند إنشاء المفتاح: "صلاحية تعديل/حذف معلومات CRM"

المسار

api key* - رمز الوصول

Body

client_id - معرّف العميل

order_id - معرّف الصفقة

variables - قاموس من المتغيرات (المفتاح هو اسم المتغير، والقيمة هي ما يجب حفظه في ذلك المتغير) (الصيغة:{"var_name": "var_velue"})

استجابة ناجحة: {"status":"success"} 
استجابة خطأ: {"status":"order 12345 not found"}

إنشاء صفقة

POST https://chatter.mavibot.ai/api/#{api_key}/create_order

URL request: https://chatter.mavibot.ai/api/#{api_key}/create_order

صلاحية الوصول عند إنشاء المفتاح: "صلاحية تعديل/حذف معلومات CRM"

المسار

api key* - رمز الوصول

Body

client_id - معرّف العميل

name - اسم الصفقة

description - وصف الصفقة

budget - مبلغ الصفقة

يجب تحديد أحد المعلمات التالية في الطلب: client_id أو email أو phone. إذا تم توفير عدة معلمات، فسيتم استخدام واحدة فقط. ترتيب الأولوية هو: client_id > phone > email. إذا تم توفير phone أو email ولم يوجد عميل بهذا رقم الهاتف أو البريد الإلكتروني، فسيتم إنشاء عميل جديد.

استجابة ناجحة: {"status":"success","order_id":40654}، 
حيث إن order_id هو معرّف الصفقة النشطة الجديدة.
استجابة خطأ: {"status":"client_not_found"}

نقل صفقة إلى مرحلة في MavibotCRM

POST https://chatter.mavibot.ai/api/#{api_key}/set_order_state

URL request: https://chatter.mavibot.ai/api/#{api_key}/set_order_state

صلاحية الوصول عند إنشاء المفتاح: "صلاحية تعديل/حذف معلومات CRM"

المسار

api key* - رمز الوصول

Body

client_id - معرّف العميل

state_id - رقم المرحلة التي يجب نقل صفقة العميل إليها

استرجاع معرّف مرحلة القمع في Mavibot CRM

GET https://chatter.mavibot.ai/api/#{api_key}/get_order_state

URL request: https://chatter.mavibot.ai/api/#{api_key}/get_order_state

صلاحية الوصول عند إنشاء المفتاح: "صلاحية قراءة معلومات CRM"

المسار

api key* - رمز الوصول

Body

client_id - معرّف العميل

state_id - معرّف الصفقة (إذا لم يُحدَّد، فستُرجع الطريقة معرّف مرحلة الصفقة الحالية)

مثال على استجابة ناجحة:
{'status': 'success', 'state_id': 123456}

مثال على استجابة غير ناجحة:
{'status': 'order not found'}

ما القدرات الأخرى المتاحة؟

التحقق مما إذا كان رقم الهاتف لديه واتساب

GET https://chatter.mavibot.ai/api/#{api_key}/check_whatsapp

URL request: https://chatter.mavibot.ai/api/#{api_key}/check_whatsapp

لاستخدام هذه الطريقة، يجب أن يكون واتساب متصلاً بـ Mavibot.

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل أو حذف معلومات العميل".

يمكن استدعاؤها باستخدام GET أو POST. يمكن إدخال رقم الهاتف بأي صيغة.

المسار

api key* - رمز الوصول

Body

phone - رقم الهاتف المطلوب التحقق منه

الحصول على قائمة تطبيقات المراسلة المتصلة بالمشروع

GET https://chatter.mavibot.ai/api/<api_key>/connected_channels

عنوان طلب URL: https://chatter.mavibot.ai/api/<api_key>/connected_channels

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل أو حذف معلومات العميل".

تعيد الدالة المعلمة group_id لكل تطبيق مراسلة، والتي يجب استخدامها عند استيراد العملاء.

بالنسبة إلى واتساب، تعيد أيضًا status حقلًا يمكن أن يأخذ القيم التالية:

NOT_STARTED = 0 STARTED = 1 ASLEEP = 2 STOPPED = 3

المسار

api key* - رمز الوصول

{'project_id': 1, 
'viber': [{
        'id': 14, 
        'uri': 'mavibotstage', 
        'name': 'mavibotstage', 
        'enabled': true,
        'group_id': 11}], 
'facebook': [], 
'telegram': [{
        'id': 23, 
        'short_name': 'bulls_vs_bears_bot', 
        'name': 'bulls_vs_bears_bot', 
        'enabled': true,
        'group_id': 'bulls_vs_bears_bot'}], 
'whatsapp': [], 
'avito': [], 
'ok': [], 
'vkontakte': [{
        'id': 33, 
        'group': '143414131',
        'group_id': '143414131'}]
}

استرجاع قائمة الكتل من مسار البوت

GET https://chatter.mavibot.ai/api/<api_key>/get_messages

URL request: https://chatter.mavibot.ai/api/<api_key>/get_messages

صلاحية الوصول عند إنشاء مفتاح: "صلاحية تعديل أو حذف معلومات العميل".

المسار

api key* - رمز الوصول

استرجاع بيانات العميل المتداخلة

delimiter

لاسترجاع client_id و/أو رقم هاتف العميل من القواميس المتداخلة (وليس في المستوى الأول)، استخدم معلمة delimiter.

أضف ما يلي إلى رابط الطلب:

?delimiter=1&delimiter_value_client_id={key1}1{key2}&delimiter_value_phone={key1}1{key2}

حيث:

?delimiter=1 – قيمة الفاصل التي تفصل بين المفاتيح {key1}1{key2}1{key3}

delimiter_value_client_id={key1}1{key2} – لاسترجاع معرّف العميل

delimiter_value_phone={key1}1{key2} – لاسترجاع رقم هاتف العميل

{key1}, {key2}, … – مفاتيح تحتوي على القيم (يمكن أن تتضمن أي أحرف باستثناء الفاصل). يمكنك استخدام عدد غير محدود من المفاتيح: ?delimiter=1&delimiter_value_client_id={key1}1{key2}1{key3}1{key4}1{key5}1{key6}. تُمرَّر المفاتيح من دون أقواس معقوفة.

استخدم الفاصل بين المفاتيح. على سبيل المثال، إذا كان delimiter=2، فسيكون {key1}2{key2}2{key3}; وإذا كان delimiter=5، فسيكون {key1}5{key2}5{key3}. تأكد من أن المفتاح لا يحتوي على حرف الفاصل.

مثال:

https://chatter.mavibot.a/aipi/<api_key>/callback?delimiter=1&delimiter_value_client_id={key1}1{key2}&delimiter_value_phone={key1}1{key2}

يمكنك أيضًا استرجاع المعرّف فقط أو رقم الهاتف فقط:

https://chatter.salebot.pro/api/<api_key>/callback?delimiter=1&delimiter_value_client_id={key1}1{key2} - فقط معرّف العميل؛

https://chatter.salebot.pro/api/<api_key>/callback?delimiter=1delimiter_value_phone={key1}1{key2} - فقط رقم الهاتف؛

طرق API:

1. بدء البوت: https://chatter.mavibotbot.ai/api/<api_key>/callback

2. بدء البوت بواسطة رقم واتساب: https://chatter.mavibotbot.ai/api/<api_key>/whatsapp_callback

3. بدء البوت بواسطة معرّف تيليغرام: https://chatter.mavibotbot.ai/api/<api_key>/tg_callback

4. إرسال رسالة callback إلى عميل البريد الإلكتروني: https://chatter.mavibotbot.ai/api/<api_key>/email_callback

5. إرسال رسالة إلى العميل: https://chatter.mavibotbot.ai/api/<api_key>/message

6. إرسال رسالة واتساب: https://chatter.mavibotbot.ai/api/<api_key>/whatsapp_message

7. إرسال رسائل جماعية: https://chatter.mavibotbot.ai/api/<api_key>/broadcast

8. تعيين المتغيرات: https://chatter.mavibotbot.ai/api/<api_key>/save_variables

إذا كنت بحاجة إلى طرق إضافية، يُرجى التواصل مع الدعم.