تخطَّ إلى المحتوى

عائلات نقاط النهاية

تُقدَّم API عبر بوابة واحدة (api.rolchat.com) توجّه كل عائلة مسارات إلى الخدمة المالكة لها. تسرد هذه الصفحة كل عائلة تعرضها البوابة للعملاء، مجمّعة حسب الوحدة. تتشارك كل العائلات الاصطلاحات - الغلاف، والترقيم، وعدم التكرار، ورموز الأخطاء - لذا يخبرك الجدول أين يقع المورد وكيف تُصادَق الاستدعاءات.

المسارات بادئات: /api/v1/contacts تشمل GET /contacts وPOST /contacts وGET /contacts/:id وPATCH /contacts/:id وهكذا. تفوز البادئة الأطول، ولهذا يمكن أن تقع عائلة فرعية عامة مثل /kb/public تحت /kb المصادَق عليها.

الفئةمن يحق له الاستدعاء
userعضو في الحساب - JWT أو مفتاح API، وX-Account-Id مطلوبة
loginمجهول، مع حدود صارمة لتسجيل الدخول (10 لكل IP في الدقيقة)
unauthenticatedمجهول
widgetمجهول، بنطاق مفتاح الموقع والمصدر (60 لكل موقع وIP في الدقيقة)
webhook-inboundموقَّع من المرسل - راجع Webhooks
partnerJWT الشريك (بوابة الشركاء)

Auth & account

البادئةالخدمةالفئة
/api/v1/authiam-servicelogin
/api/v1/captchaiam-serviceunauthenticated
/api/v1/meiam-serviceuser
/api/v1/accountsiam-serviceuser
/api/v1/account-settingsiam-serviceuser
/api/v1/usersiam-serviceuser
/api/v1/membersiam-serviceuser
/api/v1/rolesiam-serviceuser
/api/v1/tokensiam-serviceuser
/api/v1/staff-access-policyiam-serviceuser
/api/v1/staff-access-sessionsiam-serviceuser
/api/v1/presenceiam-serviceuser
/api/v1/workforceiam-serviceuser
/api/v1/sitessites-serviceuser
/api/v1/profileprofile-serviceuser
/api/v1/teamsteams-serviceuser
/api/v1/auditaudit-serviceuser

Conversations & inbox

البادئةالخدمةالفئة
/api/v1/conversationsconversation-serviceuser
/api/v1/messagesconversation-serviceuser
/api/v1/conversation-tagsconversation-serviceuser
/api/v1/inboxesconversation-serviceuser
/api/v1/viewsconversation-serviceuser
/api/v1/templatesconversation-serviceuser
/api/v1/chat-routing-rulesconversation-serviceuser
/api/v1/macrosconversation-serviceuser
/api/v1/chat-settingsconversation-serviceuser
/api/v1/tasksconversation-serviceuser

CRM

البادئةالخدمةالفئة
/api/v1/leadscrm-serviceuser
/api/v1/contactscrm-serviceuser
/api/v1/companiescrm-serviceuser
/api/v1/dealscrm-serviceuser
/api/v1/pipelinescrm-serviceuser
/api/v1/lead-statusescrm-serviceuser
/api/v1/contact-tagscrm-serviceuser
/api/v1/segmentscrm-serviceuser
/api/v1/lead-routing-rulescrm-serviceuser
/api/v1/crm-settingscrm-serviceuser
/api/v1/crm/campaignscrm-serviceuser
/api/v1/custom-fieldsmeta-serviceuser

Tickets

البادئةالخدمةالفئة
/api/v1/ticketsticket-serviceuser
/api/v1/ticket-queuesticket-serviceuser
/api/v1/ticket-settingsticket-serviceuser
/api/v1/ticket-sla-policiesticket-serviceuser
/api/v1/ticket-custom-fieldsticket-serviceuser
/api/v1/ticket-tagsticket-serviceuser

Channels & widget

البادئةالخدمةالفئة
/api/v1/channelschannel-serviceuser
/api/v1/widget-configschannel-serviceuser
/api/v1/widgetvisitor-servicewidget
/api/v1/webhookschannel-servicewebhook-inbound

Visitors

البادئةالخدمةالفئة
/api/v1/visitorsvisitor-serviceuser
/api/v1/geo-sourcevisitor-serviceuser
/api/v1/funnelsvisitor-serviceuser

Knowledge base

البادئةالخدمةالفئة
/api/v1/kbkb-serviceuser
/api/v1/kb/publickb-servicewidget

Marketing

البادئةالخدمةالفئة
/api/v1/marketingmarketing-serviceuser
/api/v1/marketing/publicmarketing-servicewidget
/api/v1/surveysmarketing-serviceuser
/api/v1/survey-responsesmarketing-serviceuser
/api/v1/meetingsmarketing-serviceuser

Phone

البادئةالخدمةالفئة
/api/v1/phone/twiliophone-servicewebhook-inbound
/api/v1/phonephone-serviceuser

Automation

البادئةالخدمةالفئة
/api/v1/automationautomation-serviceuser

Reports

البادئةالخدمةالفئة
/api/v1/reportsanalytics-serviceuser
/api/v1/dashboardsanalytics-serviceuser
/api/v1/kpianalytics-serviceuser
البادئةالخدمةالفئة
/api/v1/consentprivacy-servicewidget
/api/v1/privacyprivacy-serviceuser
/api/v1/privacy/publicprivacy-servicewidget

AI

البادئةالخدمةالفئة
/api/v1/aiplugin-serviceuser · مهلة 60 ث
/api/v1/ai/assistant/replyplugin-servicewebhook-inbound

Notifications

البادئةالخدمةالفئة
/api/v1/notifications-policynotification-serviceuser
/api/v1/notificationsnotification-serviceuser
/api/v1/notification-templatesnotification-serviceuser
/api/v1/notification-delivery-logsnotification-serviceuser
/api/v1/pushnotification-serviceuser

Media

البادئةالخدمةالفئة
/api/v1/mediamedia-serviceuser

Billing

البادئةالخدمةالفئة
/api/v1/billingbilling-serviceuser
/api/v1/billing/webhooks/stripebilling-servicewebhook-inbound

Partner portal

البادئةالخدمةالفئة
/api/v1/partnerpartner-portal-servicepartner
/api/v1/partner/authiam-servicelogin
/api/v1/partner/invitationspartner-portal-servicelogin
/api/v1/partner/auth/mfa/enrolliam-servicepartner
/api/v1/partner/auth/mfa/confirmiam-servicepartner
/api/v1/partner/auth/step-upiam-servicepartner
/api/v1/rpartner-portal-servicewidget

Identity verification (KYC)

البادئةالخدمةالفئة
/api/v1/kyc/webhooks/sumsubkyc-servicewebhook-inbound
/api/v1/kyc/webhooks/didwwkyc-servicewebhook-inbound
/api/v1/kyckyc-serviceuser

أخرى

البادئةالخدمةالفئة
/api/v1/auth/meiam-serviceuser
/api/v1/auth/sessionsiam-serviceuser
/api/v1/auth/mfaiam-serviceuser
/api/v1/auth/email-changeiam-serviceuser
/api/v1/auth/swap-companyiam-serviceuser
/api/v1/privacy/policiesprivacy-serviceuser
/api/v1/complianceprivacy-serviceuser
/api/v1/identity-graphidentity-graph-serviceuser

يُولَّد هذا الجدول من جدول مسارات البوابة في مستودع الواجهة الخلفية، مع لقطة منه محفوظة في هذا الموقع. يقارن فحص قبل كل نشر اللقطة بجدول المسارات الحالي، فلا يمكن إضافة عائلة أو إزالتها في المنتج دون أن تتغير هذه الصفحة. تُستبعد المسارات الداخلية لوحدة تحكم الموظفين. المستند OpenAPI القابل للقراءة آليًا موصوف في صفحة OpenAPI.