عائلات نقاط النهاية
تُقدَّم API عبر بوابة واحدة (api.rolchat.com) توجّه كل عائلة مسارات إلى الخدمة المالكة لها. تسرد هذه الصفحة كل عائلة تعرضها البوابة للعملاء، مجمّعة حسب الوحدة. تتشارك كل العائلات الاصطلاحات - الغلاف، والترقيم، وعدم التكرار، ورموز الأخطاء - لذا يخبرك الجدول أين يقع المورد وكيف تُصادَق الاستدعاءات.
المسارات بادئات: /api/v1/contacts تشمل GET /contacts وPOST /contacts وGET /contacts/:id وPATCH /contacts/:id وهكذا. تفوز البادئة الأطول، ولهذا يمكن أن تقع عائلة فرعية عامة مثل /kb/public تحت /kb المصادَق عليها.
فئات المصادقة
Section titled “فئات المصادقة”| الفئة | من يحق له الاستدعاء |
|---|---|
user | عضو في الحساب - JWT أو مفتاح API، وX-Account-Id مطلوبة |
login | مجهول، مع حدود صارمة لتسجيل الدخول (10 لكل IP في الدقيقة) |
unauthenticated | مجهول |
widget | مجهول، بنطاق مفتاح الموقع والمصدر (60 لكل موقع وIP في الدقيقة) |
webhook-inbound | موقَّع من المرسل - راجع Webhooks |
partner | JWT الشريك (بوابة الشركاء) |
العائلات
Section titled “العائلات”Auth & account
| البادئة | الخدمة | الفئة |
|---|---|---|
/api/v1/auth | iam-service | login |
/api/v1/captcha | iam-service | unauthenticated |
/api/v1/me | iam-service | user |
/api/v1/accounts | iam-service | user |
/api/v1/account-settings | iam-service | user |
/api/v1/users | iam-service | user |
/api/v1/members | iam-service | user |
/api/v1/roles | iam-service | user |
/api/v1/tokens | iam-service | user |
/api/v1/staff-access-policy | iam-service | user |
/api/v1/staff-access-sessions | iam-service | user |
/api/v1/presence | iam-service | user |
/api/v1/workforce | iam-service | user |
/api/v1/sites | sites-service | user |
/api/v1/profile | profile-service | user |
/api/v1/teams | teams-service | user |
/api/v1/audit | audit-service | user |
Conversations & inbox
| البادئة | الخدمة | الفئة |
|---|---|---|
/api/v1/conversations | conversation-service | user |
/api/v1/messages | conversation-service | user |
/api/v1/conversation-tags | conversation-service | user |
/api/v1/inboxes | conversation-service | user |
/api/v1/views | conversation-service | user |
/api/v1/templates | conversation-service | user |
/api/v1/chat-routing-rules | conversation-service | user |
/api/v1/macros | conversation-service | user |
/api/v1/chat-settings | conversation-service | user |
/api/v1/tasks | conversation-service | user |
CRM
| البادئة | الخدمة | الفئة |
|---|---|---|
/api/v1/leads | crm-service | user |
/api/v1/contacts | crm-service | user |
/api/v1/companies | crm-service | user |
/api/v1/deals | crm-service | user |
/api/v1/pipelines | crm-service | user |
/api/v1/lead-statuses | crm-service | user |
/api/v1/contact-tags | crm-service | user |
/api/v1/segments | crm-service | user |
/api/v1/lead-routing-rules | crm-service | user |
/api/v1/crm-settings | crm-service | user |
/api/v1/crm/campaigns | crm-service | user |
/api/v1/custom-fields | meta-service | user |
Tickets
| البادئة | الخدمة | الفئة |
|---|---|---|
/api/v1/tickets | ticket-service | user |
/api/v1/ticket-queues | ticket-service | user |
/api/v1/ticket-settings | ticket-service | user |
/api/v1/ticket-sla-policies | ticket-service | user |
/api/v1/ticket-custom-fields | ticket-service | user |
/api/v1/ticket-tags | ticket-service | user |
Channels & widget
| البادئة | الخدمة | الفئة |
|---|---|---|
/api/v1/channels | channel-service | user |
/api/v1/widget-configs | channel-service | user |
/api/v1/widget | visitor-service | widget |
/api/v1/webhooks | channel-service | webhook-inbound |
Visitors
| البادئة | الخدمة | الفئة |
|---|---|---|
/api/v1/visitors | visitor-service | user |
/api/v1/geo-source | visitor-service | user |
/api/v1/funnels | visitor-service | user |
Knowledge base
| البادئة | الخدمة | الفئة |
|---|---|---|
/api/v1/kb | kb-service | user |
/api/v1/kb/public | kb-service | widget |
Marketing
| البادئة | الخدمة | الفئة |
|---|---|---|
/api/v1/marketing | marketing-service | user |
/api/v1/marketing/public | marketing-service | widget |
/api/v1/surveys | marketing-service | user |
/api/v1/survey-responses | marketing-service | user |
/api/v1/meetings | marketing-service | user |
Phone
| البادئة | الخدمة | الفئة |
|---|---|---|
/api/v1/phone/twilio | phone-service | webhook-inbound |
/api/v1/phone | phone-service | user |
Automation
| البادئة | الخدمة | الفئة |
|---|---|---|
/api/v1/automation | automation-service | user |
Reports
| البادئة | الخدمة | الفئة |
|---|---|---|
/api/v1/reports | analytics-service | user |
/api/v1/dashboards | analytics-service | user |
/api/v1/kpi | analytics-service | user |
Privacy & consent
| البادئة | الخدمة | الفئة |
|---|---|---|
/api/v1/consent | privacy-service | widget |
/api/v1/privacy | privacy-service | user |
/api/v1/privacy/public | privacy-service | widget |
AI
| البادئة | الخدمة | الفئة |
|---|---|---|
/api/v1/ai | plugin-service | user · مهلة 60 ث |
/api/v1/ai/assistant/reply | plugin-service | webhook-inbound |
Notifications
| البادئة | الخدمة | الفئة |
|---|---|---|
/api/v1/notifications-policy | notification-service | user |
/api/v1/notifications | notification-service | user |
/api/v1/notification-templates | notification-service | user |
/api/v1/notification-delivery-logs | notification-service | user |
/api/v1/push | notification-service | user |
Media
| البادئة | الخدمة | الفئة |
|---|---|---|
/api/v1/media | media-service | user |
Billing
| البادئة | الخدمة | الفئة |
|---|---|---|
/api/v1/billing | billing-service | user |
/api/v1/billing/webhooks/stripe | billing-service | webhook-inbound |
Partner portal
| البادئة | الخدمة | الفئة |
|---|---|---|
/api/v1/partner | partner-portal-service | partner |
/api/v1/partner/auth | iam-service | login |
/api/v1/partner/invitations | partner-portal-service | login |
/api/v1/partner/auth/mfa/enroll | iam-service | partner |
/api/v1/partner/auth/mfa/confirm | iam-service | partner |
/api/v1/partner/auth/step-up | iam-service | partner |
/api/v1/r | partner-portal-service | widget |
Identity verification (KYC)
| البادئة | الخدمة | الفئة |
|---|---|---|
/api/v1/kyc/webhooks/sumsub | kyc-service | webhook-inbound |
/api/v1/kyc/webhooks/didww | kyc-service | webhook-inbound |
/api/v1/kyc | kyc-service | user |
أخرى
| البادئة | الخدمة | الفئة |
|---|---|---|
/api/v1/auth/me | iam-service | user |
/api/v1/auth/sessions | iam-service | user |
/api/v1/auth/mfa | iam-service | user |
/api/v1/auth/email-change | iam-service | user |
/api/v1/auth/swap-company | iam-service | user |
/api/v1/privacy/policies | privacy-service | user |
/api/v1/compliance | privacy-service | user |
/api/v1/identity-graph | identity-graph-service | user |
من أين تأتي القائمة
Section titled “من أين تأتي القائمة”يُولَّد هذا الجدول من جدول مسارات البوابة في مستودع الواجهة الخلفية، مع لقطة منه محفوظة في هذا الموقع. يقارن فحص قبل كل نشر اللقطة بجدول المسارات الحالي، فلا يمكن إضافة عائلة أو إزالتها في المنتج دون أن تتغير هذه الصفحة. تُستبعد المسارات الداخلية لوحدة تحكم الموظفين. المستند OpenAPI القابل للقراءة آليًا موصوف في صفحة OpenAPI.