- كيفية استلام الرسائل على رابط Webhook المحدد في إعدادات المشروع
- كيفية استخدام webhook عالمي
- كيفية تشغيل البوت
- كيفية العمل مع الرسائل
- كيفية توزيع العملاء
- كيفية العمل مع المتغيرات
- كيفية الحصول على client_id
- ما هي الإمكانيات الأخرى المتاحة
يتم تنفيذ الطلبات باستخدام طريقة POST على الرابط أي https://chatter.mavibot.ai/api/{api\_key}/{action}
أين يوجد: api_key هو مفتاح الوصول إلى API الذي يتم الحصول عليه في إعدادات المشروع:
يمكنك الحصول على مفتاح الوصول باستخدام المتغير #{api_key}. يحتوي على المفتاح المُنشأ ذي الصلة. لا تنسَ إنشاء واحد قبل استخدامه.
عند نسخ رابط الاستعلام من هذه الصفحة، يتم وضع مسافة يجب حذفها عند الاتصال
مثال على نسخ الرابط بطريقة خاطئة: https://chatter.mavibot.ai/api/callback ;
من السهل عدم ملاحظة المسافة بعد .pro ولكن إذا تركتها في مكانها، فلن يعمل الاستعلام
عند إرسال الطلب باستخدام طريقة GET، لا تستخدم الكلمات المحظورة. انظر إلى التكوين الصحيح لطلبات GET
كيفية استلام الرسائل على رابط Webhook المحدد في إعدادات المشروع
كل رسالة واردة أو صادرة تأتي مع طلبات POST التالية بصيغة json:
{
'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 وذكر اسم المعلمة التي تحتوي على هذه القيمة
لتحديد المتغير الذي يحمل الهاتف تحتاج إلى نقل value_phone وذكر اسم المعلمة التي تحتوي على هذه القيمة
لتحديد المتغير الذي يحمل البريد الإلكتروني تحتاج إلى نقل value_email وذكر اسم المعلمة التي تحتوي على هذه القيمة
لتحديد المتغير الذي يحمل user_id تحتاج إلى نقل value_user_id وذكر اسم المعلمة التي تحتوي على هذه القيمة
لتحديد المتغير الذي يحمل group_id تحتاج إلى نقل value_group_id وذكر اسم المعلمة التي تحتوي على هذه القيمة
مثال:
اكتب في العنوان 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)
معلمات المسار
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | رمز الوصول |
نص الطلب
| الاسم | النوع | الوصف |
|---|---|---|
| client_phone | string | رقم الهاتف الذي يتم من خلاله العثور على العميل |
| client_email | string | البريد الإلكتروني الذي يتم من خلاله العثور على العميل |
| client_id | string | معرف العميل في المحرر |
| message | string | نص الرسالة |
**200: OK **
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)
تشغيل البوت من خلال الرقم على WhatsApp
POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_callback
تقوم هذه الطريقة بتشغيل البوت في WhatsApp بعد أن يسجل العميل من خلال الموقع أو بعد أن يترك طلبًا مع رقم هاتفه
يتم حفظ المعلمات المنقولة الإضافية في المتغيرات
معلمات المسار
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | رمز الوصول |
نص الطلب
| الاسم | النوع | الوصف |
|---|---|---|
| name | string | اسم العميل |
| message | string | نص الرسالة |
| phone | string | رقم هاتف العميل |
| bot_id | string | معرف البوت |
**200: OK **
{
// Response
}
تشغيل البوت من خلال معرف Telegram
POST https://chatter.mavibot.ai/api/<api_key>/tg_callback
يمكن استخدام هذه الطريقة لتشغيل سير العمل أو تأكيد الإجراءات على موقع طرف ثالث. لن تكون هذه الرسالة مرئية للعميل.
يتم حفظ المعلمات المنقولة الإضافية في المتغيرات
معلمات المسار
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | رمز الوصول |
نص الطلب
| الاسم | النوع | الوصف |
|---|---|---|
| message | string | نص الرسالة |
| user_id | string | معرف المستخدم في Telegram |
| group_id | string | اسم البوت (يجب أن ينتهي بـ bot) |
**200: OK **
{
// Response
}
كيفية العمل مع الرسائل
معلمات إرسال الرسائل
attachment_type يمكن أن تأخذ هذه القيم: image, video, link, file, audio
عند إرسال المرفقات، فإن المعلمة message ليست إلزامية
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
يمكن استخدام هذه الطريقة لإرسال الرسائل مع الإشعارات. المعلمة message إلزامية إذا كنت لا ترسل ملفًا. إذا كنت ترسل ملفًا، فلن تكون هناك حاجة للنص
معلمات المسار
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | مفتاح الوصول |
نص الطلب
| الاسم | النوع | الوصف |
|---|---|---|
| message_id | string | رقم كتلة الإرسال |
| message | string | نص الرسالة |
| client_id | string | معرف العميل في المحرر |
| attachment_type | string | نوع عرض الملف |
| attachment_url | string | رابط الملف |
| buttons | object | الأزرار |
**200: OK **
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)
إرسال الرسائل في WhatsApp
POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_message
يسمح بإرسال رسالة من اسم البوت المتصل إلى الرقم المذكور whatsapp_bot_id يجب أخذه من قسم "المراسلين والدردشات". كل صفحة WhatsApp متصلة تحصل على معرف فريد
معلمات المسار
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | مفتاح الوصول |
نص الطلب
| الاسم | النوع | الوصف |
|---|---|---|
| message_id | string | رقم كتلة الإرسال |
| whatsapp_bot_id | number | بوت WhatsApp الذي يرسل الرسالة |
| attachment_url | string | رابط الملف |
| attachment_type | string | نوع عرض الملف |
| message | string | نص الرسالة |
| phone | string | رقم هاتف المستلم |
**200: OK **
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، فسيتم إرسال البث إلى جميع المستخدمين. من الضروري إما إرسال ملف أو نص
معاملات المسار
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | مفتاح الوصول |
نص الطلب
| الاسم | النوع | الوصف |
|---|---|---|
| message_id | string | رقم كتلة الإرسال |
| list | string | قائمة أرقام المستلمين |
| shift | string | عدد الثواني بين الرسائل. القيمة الافتراضية 0.2 |
| message | string | نص الرسالة |
| clients | array | معرفات المستلمين |
| attachment_type | string | نوع عرض الملف |
| attachment_url | string | رابط الملف |
| buttons | string | الأزرار |
**200: OK **
{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 هنا
معاملات المسار
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | مفتاح الوصول |
معاملات الاستعلام
| الاسم | النوع | الوصف |
|---|---|---|
| client_id | string | معرف العميل |
**200: OK **
{
"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=
معاملات المسار
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | مفتاح الوصول |
معاملات الاستعلام
| الاسم | النوع | الوصف |
|---|---|---|
| client_id | string | معرف العميل |
**200: OK **
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
تسمح الطريقة بتعيين عميل لموظف. معامل البريد الإلكتروني اختياري. إذا لم يتم توفير البريد الإلكتروني، فسيتم التوزيع من خلال خوارزمية النظام
معاملات المسار
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | مفتاح الوصول |
معاملات الاستعلام
| الاسم | النوع | الوصف |
|---|---|---|
| client_id | String | معرف العميل |
| String | البريد الإلكتروني للموظف (اختياري) |
**200: OK **
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
تسمح الطريقة بتحميل العملاء إلى النظام. عند تحميل عملاء 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 | string | مفتاح الوصول |
نص الطلب
| الاسم | النوع | الوصف |
|---|---|---|
| platform_id | String | رقم الهاتف |
| group_id | String | معرف المجموعة |
| client_type | String | نوع المراسل الذي جاء منه العميل |
**200: OK **
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
معاملات المسار
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | مفتاح الوصول |
نص الطلب
| الاسم | النوع | الوصف |
|---|---|---|
| list_id | integer | رقم القائمة |
| clients | array | مصفوفة أرقام العملاء |
**200: OK **
{
// Response
}
إزالة عملاء من القائمة
POST https://chatter.mavibot.ai/api/<api_key>/remove_from_list
معاملات المسار
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | مفتاح الوصول |
نص الطلب
| الاسم | النوع | الوصف |
|---|---|---|
| list_id | integer | رقم القائمة |
| clients | array | مصفوفة أرقام العملاء |
**200: OK **
{
// Response
}
الحصول على قائمة العملاء
POST https://chatter.mavibot.ai/api/<api_key>/get_clients
معاملات المسار
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | مفتاح الوصول |
معاملات الاستعلام
| الاسم | النوع | الوصف |
|---|---|---|
| offset | string | الإزاحة من العنصر الأول |
| limit | integer | عدد العناصر في الإجابة. القيمة الافتراضية 500، الحد الأقصى 500 |
| list | string | رقم القائمة |
200: OK ترجع حالة العناصر والمصفوفة
{
"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
الحصول على معلومات العملاء في المراسل المختار
معاملات المسار
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | مفتاح الوصول |
معاملات الاستعلام
| الاسم | النوع | الوصف |
|---|---|---|
| page | integer | |
| tag | string | العلامة التي تم ذكرها في صفحة الاشتراك |
| group | integer | معرف المجموعة التي يرتبط بها المشترك |
| date_from | integer | الطابع الزمني للتاريخ الذي اشتركوا بعده |
| date_to | integer | الطابع الزمني للتاريخ الذي اشتركوا حتى |
| client_type | integer | معرف المراسل الذي تحتاج إلى قائمة المشتركين له. إذا لم تغير شيئًا، يظهر جميع العملاء |
**200: OK **
[
{
"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"}}
معاملات المسار
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | مفتاح الوصول |
نص الطلب
| الاسم | النوع | الوصف |
|---|---|---|
| clients | array | مصفوفة معرفات العملاء لإسناد المتغيرات |
| client_id | string | معرف العميل |
| variables | object | تجزئة المتغير (قيمة المفتاح) |
**200: OK **
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=
معاملات المسار
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | رمز الوصول |
معاملات الاستعلام
| الاسم | النوع | الوصف |
|---|---|---|
| client_id | string | معرف العميل |
**200: OK **
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
تعيد هذه الطريقة معرف العميل (client id) لتنفيذ الطلبات إلى واجهة API
مثال على المعاملات: {"platform_ids": ["571830542", "256865200"]}
معاملات المسار (Path Parameters)
| الاسم | النوع | الوصف |
|---|---|---|
| string | مفتاح الوصول |
نص الطلب (Request Body)
| الاسم | النوع | الوصف |
|---|---|---|
| platform_ids | string | مصفوفة المعرفات في المراسل |
**200: OK **
[{
"id":15099119,
"tag":null,
"created_at":1618815253,
"name":"Oscar Wilde",
"avatar":"https:\/\/files.mavibot.pro\/uploads\/avatars\/256865200.jpg",
"platform_id":"2568652",
"group":"Mavibotpro_bot",
"variables":{"tg_username":"@wildeo"}},
{"id":21087377,
"tag":null,
"created_at":1626275893,
"name":"Freddie Mercury",
"avatar":"https:\/\/files.mavibot.pro\/uploads\/avatars\/571830542.jpg",
"platform_id":"571830542",
"group":"Mavibotpro_bot",
"variables":{"tg_username":"@freddieisqueen"}
}]
كيفية الحصول على معرف العميل في الدردشة المباشرة (Online chat)
GET https://chatter.mavibot.ai/api/<api_key>/online_chat_client_id?recipient=
تسمح هذه الطريقة بدمج الموقع وروبوت الدردشة، أي إذا دخل شخص إلى صفحة تحتوي على عرض خاص، يمكنك إرسال رسالة فورية حول العرض في الدردشة
معاملات المسار (Path Parameters)
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | رمز الوصول |
معاملات الاستعلام (Query Parameters)
| الاسم | النوع | الوصف |
|---|---|---|
| tag | string | علامة العميل |
| name | string | اسم العميل |
| recipient | string | معرف الحوار على الموقع |
**200: OK **
{ "client_id": 36553 }
أين تحصل على recipient؟ على الموقع الذي يستضيف الدردشة المباشرة "Mavibot.ai"، تحتاج إلى الحصول على الخاصية MaviBotPro.recipient_id باستخدام JS.
كيفية الحصول على معرف العميل باستخدام رقم WhatsApp
GET https://chatter.mavibot.ai/api/<api_key>/whatsapp_client_id?phone=
تعيد هذه الطريقة معرف العميل (client id) لتنفيذ الطلبات إلى واجهة API إذا كنت تعرف رقم هاتف العميل في WhatsApp.
إذا لم يكن هناك عميل بهذا الرقم، ستحصل على خطأ 404.
معاملات المسار (Path Parameters)
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | رمز الوصول |
معاملات الاستعلام (Query Parameters)
| الاسم | النوع | الوصف |
|---|---|---|
| phone | string | رقم الهاتف |
**200: OK **
{
// Response
}
الحصول على معرف العميل باستخدام رقم الهاتف
GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_phone?phone=
تعيد هذه الطريقة معرف العميل (client id) لتنفيذ الطلبات إلى واجهة API.
يتم البحث من خلال عملاء WhatsApp، وكذلك من خلال المتغيرات.
معاملات المسار (Path Parameters)
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | رمز الوصول |
معاملات الاستعلام (Query Parameters)
| الاسم | النوع | الوصف |
|---|---|---|
| phone | string | رقم الهاتف |
**200: OK **
{
// Response
}
الحصول على معرف العميل عبر البريد الإلكتروني
GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_email?email=
تعيد هذه الطريقة معرف العميل (client id) لتنفيذ الطلبات إلى واجهة API. يتم البحث من خلال المتغيرات.
معاملات المسار (Path Parameters)
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | رمز الوصول |
معاملات الاستعلام (Query Parameters)
| الاسم | النوع | الوصف |
|---|---|---|
| string | البريد الإلكتروني للبحث |
**200: OK **
{
// Response
}
الحصول على معرف العميل بقيمة المتغير
GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_var?var=&val=
تعيد هذه الطريقة معرف العميل (client id) لتنفيذ الطلبات إلى واجهة API
معاملات المسار (Path Parameters)
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | رمز الوصول |
معاملات الاستعلام (Query Parameters)
| الاسم | النوع | الوصف |
|---|---|---|
| var | string | اسم المتغير الذي سيتم البحث من خلاله |
| val | string | قيمة المتغير |
**200: OK **
{
// Response
}
ما هي الإمكانيات الأخرى المتاحة
نقل المعاملة إلى حالة MavibotCRM
POST https://chatter.mavibot.ai/api/<api_key>/set_order_state
يمكن الحصول على رقم المعاملة في نافذة تحرير سير عمل MavibotCRM.
معاملات المسار (Path Parameters)
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | مفتاح الوصول |
نص الطلب (Request Body)
| الاسم | النوع | الوصف |
|---|---|---|
| client_id | string | معرف العميل |
| state_id | string | رقم الحالة لنقل معاملة العميل إليها |
**200: OK **
{
// Response
}
التحقق مما إذا كان الشخص يتابع حساب Instagram
GET https://chatter.mavibot.ai/api/<api_key>/check_insta_subscription
يمكن استدعاؤها بطريقة POST أو GET
معاملات المسار (Path Parameters)
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | مفتاح الوصول |
نص الطلب (Request Body)
| الاسم | النوع | الوصف |
|---|---|---|
| user_name | string | اسم المستخدم للعميل الذي تريد التحقق منه |
| login | string | تسجيل الدخول للبوت الذي يتم التحقق منه |
200: OK الحقل is_follower هو الذي يحتوي على معلومات حول ما إذا كان الشخص يتابع أم لا
{
"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
}
التحقق مما إذا كان رقم الهاتف يحمل WhatsApp
GET https://chatter.mavibot.ai/api/<api_key>/check_whatsapp
لاستخدام هذه الطريقة، يجب أن يكون لديك WhatsApp وMavibot متصلين
يمكن استدعاؤها بطريقة POST أو GET
يمكن إرسال رقم الهاتف بأي تنسيق
معاملات المسار (Path Parameters)
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | رمز الوصول |
نص الطلب (Request Body)
| الاسم | النوع | الوصف |
|---|---|---|
| phone | string | رقم الهاتف |
**200: OK **
{
// Response
}
الحصول على قائمة المراسلين المتصلين بالمشروع (بما في ذلك group_id)
GET https://chatter.mavibot.ai/api/<api_key>/connected_channels
تعيد الدالة المعامل group_id لكل مراسل، وهو الذي يجب إرساله عند تحميل العملاء
الحقل status يعود أيضًا لـ WhatsApp، ويحمل قيمة:
NOT_STARTED = 0
STARTED = 1
ASLEEP = 2
STOPPED = 3
معاملات المسار (Path Parameters)
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | رمز الوصول |
**200: OK **
{'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': []
}
الحصول على قائمة الكتل من مخطط البوت
GET https://chatter.mavibot.ai/api/<api_key>/get_messages
معاملات المسار (Path Parameters)
| الاسم | النوع | الوصف |
|---|---|---|
| api_key | string | رمز الوصول |
**200: OK **
{
// Response
}
إذا كنت بحاجة إلى طرق إضافية، يرجى الاتصال بدعم العملاء