واجهة برمجة التطبيقات لبرنامج التحرير

ما الطلبات التي يدعمها برنامج التحرير وكيفية تنفيذها

يتم تنفيذ الطلبات باستخدام الطريقة POST على عنوان URL أيّ https://chatter.mavibot.ai/api/{api_key}/{action}

أين يقع: api_key هو المفتاح للوصول إلى واجهة API والذي يتم الحصول عليه في إعدادات المشروع:

يمكنك الحصول على مفتاح الوصول باستخدام المتغير #{api_key}. يحتوي على المفتاح المُولَّد المناسب. لا تنسَ توليد واحد قبل استخدامه.

عند نسخ عنوان URL الخاص بالاستعلام من هذه الصفحة تُضاف مسافة يجب حذفها عند الاستدعاء

مثال على نسخ الرابط بطريقة خاطئة: https://chatter.mavibot.ai/api/callback

من السهل عدم ملاحظة المسافة بعد .pro، لكن إذا تُركت فلن يعمل الاستعلام

عند إرسال الطلب باستخدام طريقة GET، لا تستخدم الكلمات المحظورة. اطّلع على الصياغة الصحيحة لطلبات GET

كيفية استلام الرسائل على عنوان 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': الرسالة التي تشرح الخطأ
}

إذا عاد الطلب بخطأ فلن يُعاد إرساله. وإذا عاد الخادم بخطأ فستصل الإشعارات رغم ذلك.

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

يمكن الآن تشغيل هذه الطرق باستخدام كلٍّ من طلب POST وطلب GET.

سابقًا، كانت المعلمات (التي تُشغَّل بها طرق العملاء، أيّ client_id) مكتوبة بشكل صارم جدًا في طرقنا، وكان ذلك يفرض بعض القيود عند استخدامها مع الخدمات الخارجية.

يمكنك الآن تحديد في أيّ معلمة من الطلب سيبحث Mavibot عن معرّف المستخدم: ولهذا تُستخدم معلمة بالبادئة value_ مثل value_user_id و value_group_id.

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

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

وذلك مفيد عند إعداد استقبال webhook عبر موقع آخر.

لتحديد أيّ متغير يحتوي على client_id تحتاج إلى تمرير value_client_id وذكر اسم المعلمة التي تحتوي على هذه القيمة

لتحديد أيّ متغير يحتوي على phone تحتاج إلى تمرير value_phone وذكر اسم المعلمة التي تحتوي على هذه القيمة

لتحديد أيّ متغير يحتوي على email تحتاج إلى تمرير value_email وذكر اسم المعلمة التي تحتوي على هذه القيمة

لتحديد أيّ متغير يحتوي على user_id تحتاج إلى تمرير value_user_id وذكر اسم المعلمة التي تحتوي على هذه القيمة

لتحديد أيّ متغير يحتوي على group_id تحتاج إلى تمرير value_group_id وذكر اسم المعلمة التي تحتوي على هذه القيمة

مثال:

اكتب في القيمة address 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.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback {"client_id":49177759, "message":"Hello world"}

كما ترى، فإن اسم المعلمة التي تحتوي على الاسم يتم تمييزه بواسطة البادئة value_

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

تشغيل البوت

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

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

معلمات المسار

Name

النوع

الوصف

api_key

لـ

رمز الوصول

جسم الطلب

Name

النوع

الوصف

client_phone

لـ

رقم الهاتف الذي يُعثر على العميل من خلاله

client_email

لـ

البريد الإلكتروني الذي يُعثر على العميل من خلاله

client_id

لـ

معرّف العميل في المحرر

message

لـ

نص الرسالة

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

تشغيل البوت عبر الرقم على واتساب

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

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

معلمات المسار

Name

النوع

الوصف

api_key

لـ

رمز الوصول

جسم الطلب

Name

النوع

الوصف

name

لـ

اسم العميل

message

لـ

نص الرسالة

phone

لـ

رقم هاتف العميل

bot_id

لـ

معرّف البوت

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

تشغيل البوت عبر معرف Telegram

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

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

تُحفظ المعلمات المنقولة إضافيًا في المتغيرات

معلمات المسار

Name

النوع

الوصف

api_key

لـ

رمز الوصول

جسم الطلب

Name

النوع

الوصف

message

لـ

نص الرسالة

user_id

لـ

معرّف المستخدم في Telegram

group_id

لـ

اسم البوت (يجب أن ينتهي بـ bot)

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

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

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

attachment_type يمكن أن تأخذ هذه القيم: صورة، فيديو، رابط، ملف، صوت عند إرسال المرفقات فإن المعلمة message ليست إلزامية

buttons تحدد الأزرار التي ستُرفق بالرسالة. صيغة الأزرار مماثلة للإعدادات المتقدمة للزر. هناك متغيران ممكنان لإرسال الأزرار: أحدهما مع التلميح في المراسلات التي لا تحتوي على أزرار، والآخر بدونه

إليك مثال على معلمة الأزرار:

"buttons": {"hint": "سيظهر هذا النص في واتساب",
 "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

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

معلمات المسار

Name

النوع

الوصف

api_key

لـ

مفتاح الوصول

جسم الطلب

Name

النوع

الوصف

message_id

لـ

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

message

لـ

نص الرسالة

client_id

لـ

معرّف العميل في المحرر

attachment_type

لـ

نوع عرض الملف

attachment_url

لـ

رابط الملف

buttons

كائن

buttons

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)

إرسال الرسائل في واتساب

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

يسمح بإرسال رسالة باسم البوت المتصل إلى الرقم المذكور whatsapp_bot_id يجب أخذه من قسم “Messengers and chats”. كل صفحة واتساب متصلة تحصل على تعريف فريد

معلمات المسار

Name

النوع

الوصف

api_key

لـ

مفتاح الوصول

جسم الطلب

Name

النوع

الوصف

message_id

لـ

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

whatsapp_bot_id

الرقم

بوت واتساب الذي يرسل الرسالة

attachment_url

لـ

رابط الملف

attachment_type

لـ

نوع عرض الملف

message

لـ

نص الرسالة

phone

لـ

رقم هاتف المستلم

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

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

معلمات المسار

Name

النوع

الوصف

api_key

لـ

مفتاح الوصول

جسم الطلب

Name

النوع

الوصف

message_id

لـ

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

list

لـ

قائمة أرقام المستلمين

shift

لـ

عدد الثواني بين الرسائل. الافتراضي 0.2

message

لـ

نص الرسالة

clients

مصفوفة

معرّفات المستلمين

attachment_type

لـ

نوع عرض الملف

attachment_url

لـ

رابط الملف

buttons

لـ

buttons

{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=

الحصول على سجل الرسائل. يمكنك الحصول على client_id المعلمة هنا

معلمات المسار

Name

النوع

الوصف

api_key

لـ

مفتاح الوصول

معلمات الاستعلام

Name

النوع

الوصف

client_id

لـ

معرّف العميل

{
  "status": "success",
  "result": [
    {
      "id": 104500,
      "answered": true,
      "client_replica": false,
      "message_id": 390,
      "message_from_outside": 0,
      "created_at": 1587895014,
      "text": "CouCou",
      "attachments": {
        
      },
      "delivered": true,
      "error_message": "true"
    },
  ]
}

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

GET https://chatter.mavibot.ai/api/<api_key>/clear_history?client_id=

معلمات المسار

Name

النوع

الوصف

api_key

لـ

مفتاح الوصول

معلمات الاستعلام

Name

النوع

الوصف

client_id

لـ

معرّف العميل

import requests
import json


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

كيفية توزيع العملاء

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

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

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

معلمات المسار

Name

النوع

الوصف

api_key

لـ

مفتاح الوصول

معلمات الاستعلام

Name

النوع

الوصف

client_id

سلسلة نصية

معرّف العميل

البريد الإلكتروني

سلسلة نصية

بريد إلكتروني للعامل (اختياري)

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

معلمات المسار

Name

النوع

الوصف

api_key

لـ

مفتاح الوصول

جسم الطلب

Name

النوع

الوصف

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

معلمات المسار

Name

النوع

الوصف

api_key

لـ

مفتاح الوصول

جسم الطلب

Name

النوع

الوصف

list_id

عدد صحيح

رقم القائمة

clients

مصفوفة

مصفوفة أرقام العملاء

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

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

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

معلمات المسار

Name

النوع

الوصف

api_key

لـ

مفتاح الوصول

جسم الطلب

Name

النوع

الوصف

list_id

عدد صحيح

رقم القائمة

clients

مصفوفة

مصفوفة أرقام العملاء

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

الحصول على قائمة العملاء

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

معلمات المسار

Name

النوع

الوصف

api_key

لـ

مفتاح الوصول

معلمات الاستعلام

Name

النوع

الوصف

offset

لـ

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

limit

عدد صحيح

عدد العناصر في الإجابة. الافتراضي 500، والحد الأقصى 500

list

لـ

رقم القائمة

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

الحصول على قائمة المشتركين في أيّ مراسلة

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

الحصول على معلومات العملاء في المراسلة المختارة

معلمات المسار

Name

النوع

الوصف

api_key

لـ

مفتاح الوصول

معلمات الاستعلام

Name

النوع

الوصف

page

عدد صحيح

tag

لـ

الوسم الذي ذُكر في صفحة الاشتراك

group

عدد صحيح

معرّف المجموعة التي يرتبط بها المشترك

date_from

عدد صحيح

طابع زمني للتاريخ بعد اشتراكهم

date_to

عدد صحيح

طابع زمني للتاريخ الذي اشتركوا حتى

client_type

عدد صحيح

معرّف المراسلة التي تحتاج إلى إظهار القائمة الفرعية فيها. إذا لم تغيّر شيئًا فسيظهر جميع العملاء

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

الإذن بحذف العملاء

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

صلاحية الوصول عند توليد المفتاح: “الإذن بحذف العملاء”

المعلمات

المسار api key* — رمز الوصول

الجسم client_ids — قائمة بمعرّفات العملاء المراد حذفهم. الحد الأقصى 500. مثال: [199571, 199707, 1935722]

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

إسناد المتغيرات

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

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

المعلمة clients تسمح بإسناد المتغيرات بشكل جماعي

مثال: {"client_id":49177759, "variables": {"client.phone":"1234567890"}}

معلمات المسار

Name

النوع

الوصف

api_key

لـ

مفتاح الوصول

جسم الطلب

Name

النوع

الوصف

clients

مصفوفة

مصفوفة معرّفات العملاء لإسناد المتغيرات

client_id

لـ

معرّف العميل

المتغيرات

كائن

تجزئة المتغير (مفتاح/قيمة)

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=

معلمات المسار

Name

النوع

الوصف

api_key

لـ

رمز الوصول

معلمات الاستعلام

Name

النوع

الوصف

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

تُعيد الطريقة معرّف العميل لتنفيذ الطلبات إلى واجهة API

مثال على المعلمات: {"platform_ids": ["571830542", "256865200"]}

معلمات المسار

Name

النوع

الوصف

لـ

مفتاح الوصول

جسم الطلب

Name

النوع

الوصف

platform_ids

لـ

مصفوفة المعرفات في المراسلة

[{
"id":15099119,
"tag":null,
"created_at":1618815253,
"name":"Oscar Wilde",
"avatar":"https:\\/\\/files.salebot.pro\\/uploads\\/avatars\\/256865200.jpg",
"platform_id":"2568652",
"group":"Salebotpro_bot",
"variables":{"tg_username":"@wildeo"}},

{"id":21087377,
"tag":null,
"created_at":1626275893,
"name":"Freddie Mercury",
"avatar":"https:\\/\\/files.salebot.pro\\/uploads\\/avatars\\/571830542.jpg",
"platform_id":"571830542",
"group":"Salebotpro_bot",
"variables":{"tg_username":"@freddieisqueen"}
}]

كيفية الحصول على معرّف العميل في الدردشة المباشرة

GET https://chatter.mavibot.ai/api/<api_key>/online_chat_client_id?recipient=

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

معلمات المسار

Name

النوع

الوصف

api_key

لـ

رمز الوصول

معلمات الاستعلام

Name

النوع

الوصف

tag

لـ

وسم العميل

name

لـ

اسم العميل

recipient

لـ

معرّف الحوار في الموقع

{ "client_id": 36553 }

من أين تحصل على recipient؟ في الموقع الذي يستخدم الدردشة المباشرة “Mavibot.ai” تحتاج إلى الحصول على الخاصية SaleBotPro.recipient_id بمساعدة JavaScript.

كيفية الحصول على معرّف العميل باستخدام رقم واتساب

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

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

معلمات المسار

Name

النوع

الوصف

api_key

لـ

رمز الوصول

معلمات الاستعلام

Name

النوع

الوصف

phone

لـ

رقم الهاتف

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

الحصول على معرّف العميل باستخدام رقم الهاتف

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

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

معلمات المسار

Name

النوع

الوصف

api_key

لـ

رمز الوصول

معلمات الاستعلام

Name

النوع

الوصف

phone

لـ

رقم الهاتف

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

الحصول على معرّف العميل عبر البريد الإلكتروني

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_email?email=

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

معلمات المسار

Name

النوع

الوصف

api_key

لـ

رمز الوصول

معلمات الاستعلام

Name

النوع

الوصف

البريد الإلكتروني

لـ

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

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

الحصول على معرّف العميل حسب قيمة المتغير

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_var?var=&val=

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

معلمات المسار

Name

النوع

الوصف

api_key

لـ

رمز الوصول

معلمات الاستعلام

Name

النوع

الوصف

var

لـ

اسم المتغير الذي سيُجرى البحث من خلاله

val

لـ

قيمة المتغير

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

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

نقل المعاملة إلى حالة MavibotCRM

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

يمكن الحصول على رقم المعاملة في نافذة تحرير سير العمل في MavibotCRM.

معلمات المسار

Name

النوع

الوصف

api_key

لـ

مفتاح الوصول

جسم الطلب

Name

النوع

الوصف

client_id

لـ

معرّف العميل

state_id

لـ

رقم الحالة التي سيتم نقل معاملة العميل إليها

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

التحقق مما إذا كان الشخص يتابع حساب إنستغرام

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

يمكن استدعاؤها بكلٍّ من طريقة POST وطريقة GET

معلمات المسار

Name

النوع

الوصف

api_key

لـ

مفتاح الوصول

جسم الطلب

Name

النوع

الوصف

user_name

لـ

اسم المستخدم للعميل الذي تريد التحقق منه

لـ

تسجيل الدخول الخاص بالبوت الجاري التحقق منه

{
"username": "beyonce",
"account_id": "1463220603",
"avatar": "https://instagram.fhel6-1.fna.fbcdn.net/v/t51.2885-19/1060168..",
"real_name": "Beyonce",
"is_follower": true,
"status": 200
}

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

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

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

يمكن استدعاؤها بكلٍّ من طريقة POST وطريقة GET يمكن تمرير رقم الهاتف بأيّ صيغة

معلمات المسار

Name

النوع

الوصف

api_key

لـ

رمز الوصول

جسم الطلب

Name

النوع

الوصف

phone

لـ

رقم الهاتف

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

الحصول على قائمة المراسلات المتصلة بالمشروع (بما في ذلك group_id)

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

تعيد الدالة المعلمة group_id لكل مراسلة وهي التي يجب تمريرها عند تحميل العملاء

يمكن استخدام الحقل status كما تُعيد أيضًا لواتساب، وتحمل قيمة: NOT_STARTED = 0 STARTED = 1 ASLEEP = 2 STOPPED = 3

معلمات المسار

Name

النوع

الوصف

api_key

لـ

رمز الوصول

{'project_id': 1, 
'viber': [{
        'id': 14, 
        'uri': 'salebotstage', 
        'name': 'salebotstage', 
        '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': [] 
}

الحصول على قائمة الكتل من مخطط البوت

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

معلمات المسار

Name

النوع

الوصف

api_key

لـ

رمز الوصول

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

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

Previousالعمل مع API Nextالتكامل مع واجهات برمجة تطبيقات خارجية

Last updated 4 months ago

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

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

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

hashtagتشغيل البوت

hashtagمعلمات المسار

hashtagجسم الطلب

hashtagتشغيل البوت عبر الرقم على واتساب

hashtagمعلمات المسار

hashtagجسم الطلب

hashtagتشغيل البوت عبر معرف Telegram

hashtagمعلمات المسار

hashtagجسم الطلب

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

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

hashtagمعلمات المسار

hashtagجسم الطلب

hashtagإرسال الرسائل في واتساب

hashtagمعلمات المسار

hashtagجسم الطلب

hashtagإرسال الرسائل بشكل جماعي

hashtagمعلمات المسار

hashtagجسم الطلب

hashtagالحصول على سجل الرسائل

hashtagمعلمات المسار

hashtagمعلمات الاستعلام

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

hashtagمعلمات المسار

hashtagمعلمات الاستعلام

hashtagكيفية توزيع العملاء

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

hashtagمعلمات المسار

hashtagمعلمات الاستعلام

hashtagتحميل العملاء إلى النظام

hashtagمعلمات المسار

hashtagجسم الطلب

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

hashtagمعلمات المسار

hashtagجسم الطلب

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

hashtagمعلمات المسار

hashtagجسم الطلب

hashtagالحصول على قائمة العملاء

hashtagمعلمات المسار

hashtagمعلمات الاستعلام

hashtagالحصول على قائمة المشتركين في أيّ مراسلة

hashtagمعلمات المسار

hashtagمعلمات الاستعلام

hashtagالإذن بحذف العملاء

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

hashtagإسناد المتغيرات

hashtagمعلمات المسار

hashtagجسم الطلب

hashtagالحصول على المتغيرات

hashtagمعلمات المسار

hashtagمعلمات الاستعلام

hashtagكيفية الحصول على client_id

hashtagالحصول على client_id حسب قيمة platform_id

hashtagمعلمات المسار

hashtagجسم الطلب

hashtagكيفية الحصول على معرّف العميل في الدردشة المباشرة

hashtagمعلمات المسار

hashtagمعلمات الاستعلام

hashtagكيفية الحصول على معرّف العميل باستخدام رقم واتساب

hashtagمعلمات المسار

hashtagمعلمات الاستعلام

hashtagالحصول على معرّف العميل باستخدام رقم الهاتف

hashtagمعلمات المسار

hashtagمعلمات الاستعلام

hashtagالحصول على معرّف العميل عبر البريد الإلكتروني

hashtagمعلمات المسار

hashtagمعلمات الاستعلام

hashtagالحصول على معرّف العميل حسب قيمة المتغير

hashtagمعلمات المسار

hashtagمعلمات الاستعلام

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

hashtagنقل المعاملة إلى حالة MavibotCRM

hashtagمعلمات المسار

hashtagجسم الطلب

hashtagالتحقق مما إذا كان الشخص يتابع حساب إنستغرام

hashtagمعلمات المسار

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

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

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

تشغيل البوت

معلمات المسار

جسم الطلب

تشغيل البوت عبر الرقم على واتساب

معلمات المسار

جسم الطلب

تشغيل البوت عبر معرف Telegram

معلمات المسار

جسم الطلب

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

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

معلمات المسار

جسم الطلب

إرسال الرسائل في واتساب

معلمات المسار

جسم الطلب

إرسال الرسائل بشكل جماعي

معلمات المسار

جسم الطلب

الحصول على سجل الرسائل

معلمات المسار

معلمات الاستعلام

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

معلمات المسار

معلمات الاستعلام

كيفية توزيع العملاء

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

معلمات المسار

معلمات الاستعلام

تحميل العملاء إلى النظام

معلمات المسار

جسم الطلب

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

معلمات المسار

جسم الطلب

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

معلمات المسار

جسم الطلب

الحصول على قائمة العملاء

معلمات المسار

معلمات الاستعلام

الحصول على قائمة المشتركين في أيّ مراسلة

معلمات المسار

معلمات الاستعلام

الإذن بحذف العملاء

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

إسناد المتغيرات

معلمات المسار

جسم الطلب

الحصول على المتغيرات

معلمات المسار

معلمات الاستعلام

كيفية الحصول على client_id

الحصول على client_id حسب قيمة platform_id

معلمات المسار

جسم الطلب

كيفية الحصول على معرّف العميل في الدردشة المباشرة

معلمات المسار

معلمات الاستعلام

كيفية الحصول على معرّف العميل باستخدام رقم واتساب

معلمات المسار

معلمات الاستعلام

الحصول على معرّف العميل باستخدام رقم الهاتف

معلمات المسار

معلمات الاستعلام

الحصول على معرّف العميل عبر البريد الإلكتروني

معلمات المسار

معلمات الاستعلام

الحصول على معرّف العميل حسب قيمة المتغير

معلمات المسار

معلمات الاستعلام

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

نقل المعاملة إلى حالة MavibotCRM

معلمات المسار

جسم الطلب

التحقق مما إذا كان الشخص يتابع حساب إنستغرام

معلمات المسار