إنتقل إلى المحتوى الرئيسي

مرجع REST API

جميع نقاط نهاية API مسبوقة بـ /api/ وتتطلب المصادقة عبر ملف تعريف ارتباط الجلسة. جميع الطلبات والاستجابات تستخدم Content-Type: application/json.

المحادثات​

نقطة النهايةالطريقةالوصف
/api/conversationsGETعرض المحادثات (فلاتر: status, channel_type, tag, search, page)
/api/conversations/{id}GETالحصول على محادثة (يعيد تعيين unread_count)
/api/conversationsPOSTإنشاء محادثة
/api/conversations/{id}/statusPOSTتحديث الحالة
/api/conversations/{id}/tagsPOSTإضافة وسم
/api/conversations/{id}/tags/{tag}DELETEإزالة وسم
/api/conversations/{id}/assignPOSTتعيين وكيل

الرسائل​

نقطة النهايةالطريقةالوصف
/api/conversations/{id}/messagesGETعرض الرسائل
/api/conversations/{id}/messagesPOSTإرسال رسالة

اقتراح الذكاء الاصطناعي​

نقطة النهايةالطريقةالوصف
/api/ai-suggest?conversation_id={id}GETالحصول على اقتراح رد الذكاء الاصطناعي

جهات الاتصال​

نقطة النهايةالطريقةالوصف
/api/contactsGETعرض جهات الاتصال
/api/contacts/{id}GETالحصول على جهة اتصال
/api/contactsPOSTإنشاء جهة اتصال
/api/contacts/{id}PATCHتحديث جهة اتصال
/api/contacts/{id}DELETEحذف جهة اتصال (المسؤول)

القنوات (المسؤول فقط)​

نقطة النهايةالطريقةالوصف
/api/channelsGETعرض القنوات
/api/channelsPOSTإنشاء قناة
/api/channels/{id}PATCHتحديث قناة
/api/channels/{id}DELETEحذف قناة

الأتمتة (المسؤول فقط)​

نقطة النهايةالطريقةالوصف
/api/automationsGETعرض الأتمتة
/api/automationsPOSTإنشاء أتمتة
/api/automations/{id}/togglePOSTتبديل نشط/غير نشط
/api/automations/{id}DELETEحذف أتمتة

التحليلات​

نقطة النهايةالطريقةالوصف
/api/analytics?days=30GETالحصول على بيانات التحليلات

الوكلاء (المسؤول فقط)​

نقطة النهايةالطريقةالوصف
/api/agentsGETعرض الوكلاء
/api/agentsPOSTإنشاء وكيل
/api/agents/{id}/rolePOSTتحديث الدور
/api/agents/{id}DELETEحذف وكيل

الإعدادات​

نقطة النهايةالطريقةالوصف
/api/settings/workspaceGETالحصول على إعدادات مساحة العمل
/api/settings/workspacePOSTتحديث مساحة العمل (المسؤول)
/api/settings/passwordPOSTتغيير كلمة المرور

صيغة الخطأ​

{"error": "Human-readable error message"}
الرمزالمعنى
200نجاح
201تم الإنشاء
400طلب غير صالح
401غير مصادق
403محظور
404غير موجود
409تعارض
500خطأ داخلي