منشئ API

عنوان URL للطلب: https://chatter.mavibot.ai/api/#{api\_key}/callback

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

يرجى الملاحظة: أي معلمات تقوم بتمريرها بالإضافة إلى ذلك سيتم حفظها في متغير

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

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

المسار

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

النص

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)

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

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

يرجى ملاحظة: أي معاملات تقوم بإضافتها سيتم حفظها في متغير

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

المسار

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

الجسم

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.

URL request: https://chatter.mavibot.pro/api/#{api\\_key}/tg\\_callback

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

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

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

المسار

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

الجسم

message - نص الرسالة
user_id - معرف مستخدم تيليجرام
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.

URL request: https://chatter.mavibot.ai/api/#{api\\_key}/send\\_callback\\_by\\_platform\\_id

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

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

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

المسار

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

الجسم

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

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

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

URL request: https://chatter.mavibot.ai/api/#{api\\_key}/email\\_callback

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

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

يرجى ملاحظة: أي معاملات تقوم بإضافتها سيتم حفظها في متغير

المسار

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

الجسم

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.

URL الطلب: https://chatter.mavibot.ai/api/#{api\\_key}/message

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

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

المسار

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

الجسم

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'
# حسب نوع المرفق: فيديو أو صورة أو مستند.

URL الطلب: https://chatter.mavibot.pro/api/\\<api_key>/whatsapp_message>

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

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

المسار

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

الجسم

message_id - رقم الكتلة للإرسال
whatsapp_bot_id - معرف بوت واتساب الذي يجب إرسال الرسالة منه
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)

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* - رمز الوصول

الجسم

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)

URL request: https://chatter.mavibot.ai/api/#{api\_key}/get\_history?client\_id=

يمكن الحصول على معامل client_id من هنا. ссылка

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

المسار

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

المحتوى

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]"
    },
  ]
}

URL request: https://chatter.mavibot.ai/api/#{api\_key}/clear\_history?client\_id=

يحذف سجل المحادثات

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

المسار

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

المحتوى

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

import requests
import json


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

URL request: https://chatter.mavibot.ai/api/#{api\_key}/assign\_to\_user

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

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

المسار

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

المحتوى

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)

URL request: https://chatter.mavibot.pro/api/#{api\_key}/load\_clients

تتيح هذه الطريقة استيراد العملاء إلى النظام. عند تحميل عملاء واتساب، يمكنك تقديم الرقم بأي تنسيق، سواء مع النهاية @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* - رمز الوصول

المحتوى

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}]}

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

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

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

المسار

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

المحتوى

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

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

URL request: https://chatter.mavibot.ai/api/#{api\_key}/remove\_from\_list

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

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

المسار

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

المحتوى

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

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

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

المسار

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

المحتوى

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
    }
]
}

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

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

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

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

المسار

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

المحتوى

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"
    }
  }
]

URL request: https://chatter.mavibot.ai/api/#{api\_key}/save\_variables

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

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

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

تحديث: يسمح معامل clients بتعيين المتغيرات بشكل مجمع.
مثال: {"client_id":49177759, "variables":{"client.phone":"88888888888"}}

المسار

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

المحتوى

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)

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* - رمز الوصول

المحتوى

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

import requests
import json


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

URL request: https://chatter.mavibot.ai/api/#{api\_key}/find\_client\_id\_by\_platform\_id

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

المسار

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

المحتوى

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"}
}]

URL request: https://chatter.mavibot.ai/api/#{api\_key}/online\_chat\_client\_id?recipient=

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

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

المسار

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

الجسم

tag - العلامة (علامة العميل)
name - اسم العميل
recipient - معرف الحوار على الموقع الإلكتروني

أين يمكن الحصول على الـ recipient؟

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

{ "client_id": 36553 }

طلب URL: https://chatter.mavibot.ai/api/#{api\_key}/whatsapp\_client\_id?phone=

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

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

المسار

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

الجسم

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

طلب URL: https://chatter.mavibot.ai/api/\<api_key>/find_client_id_by_phone?phone=

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

يتم البحث بين عملاء WhatsApp وعبر المتغيرات.

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

المسار

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

الجسم

phone - رقم الهاتف

طلب URL: https://chatter.mavibot.ai/api/#{api\_key}/find\_client\_id\_by\_email?email=&#x20;

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

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

المسار

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

الجسم

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

طلب URL: https://chatter.mavibot.ai/api/#{api\_key}/find\_client\_id\_by\_var?var=\&val=

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

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

المسار

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

الجسم

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

طلب URL: https://chatter.mavibot.ai/api/#{api\_key}/find\_latest\_client\_id\_by\_var ?var=&val=

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

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

المسار

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

الجسم

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

طلب URL: https://chatter.mavibot.ai/api/#{api\_key}/find\_all\_client\_id\_by\_var?var=\&val=

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

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

المسار

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

الجسم

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

{
    // الرد
}

طلب URL: https://chatter.mavibot.ai/api/#{api\_key}/find\_all\_client\_id\_by\_several\_vars?var=val

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

المسار

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

الجسم

variable1 - القيمة1

variable2 - القيمة2

variable3 - القيمة3

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

طلب 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* - رمز الوصول

الجسم

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"}

طلب URL: https://chatter.mavibot.ai/api/#{api\_key}/get\_current\_order\_id

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

المسار

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

الجسم

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

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

طلب URL: https://chatter.mavibot.ai/api/#{api\_key}/get\_orders

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

المسار

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

الجسم

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

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

الرد الناجح: {"status":"success","order_id":[40338,40340,40341]} 
الرد الخطأ: {"status":"client_not_found"}

طلب URL: https://chatter.mavibot.ai/api/#{api\_key}/move\_order\_to\_next\_state

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

المسار

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

الجسم

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

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

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

طلب URL: https://chatter.mavibot.ai/api/#{api\_key}/get\_order\_vars

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

المسار

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

الجسم

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

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

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

الرد الناجح: 
{"status":"success","result":{"var_name1":"111","var_name2":"13.04.2023"}} 

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

طلب URL: https://chatter.mavibot.ai/api/#{api\_key}/set\_order\_vars

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

المسار

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

الجسم

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

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

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

الرد الناجح: {"status":"success"} 
الرد الخطأ: {"status":"order 12345 not found"}

طلب URL: https://chatter.mavibot.ai/api/#{api\_key}/create\_order

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

المسار

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

الجسم

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: https://chatter.mavibot.ai/api/#{api\_key}/set\_order\_state

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

المسار

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

المحتوى

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

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

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

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

طلب URL: https://chatter.mavibot.ai/api/#{api\_key}/get\_order\_state

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

المسار

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

المحتوى

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

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

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

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

ما هي الإمكانيات الأخرى المتاحة؟

التحقق مما إذا كان رقم الهاتف يحتوي على WhatsApp

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

طلب URL: https://chatter.mavibot.ai/api/#{api\_key}/check\_whatsapp

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

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

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

المسار

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

المحتوى

phone - رقم الهاتف المراد التحقق منه

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

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

طلب URL: https://chatter.mavibot.ai/api/\<api_key>/connected_channels

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

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

بالنسبة لـ WhatsApp، ترجع أيضًا حقل 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: https://chatter.mavibot.ai/api/\<api_key>/get_messages

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

المسار

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

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

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