एंडपॉइंट फ़ैमिली
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 | अनाम, सख़्त साइन-इन सीमाएँ (प्रति IP प्रति मिनट 10) |
unauthenticated | अनाम |
widget | अनाम, साइट कुंजी और ओरिजिन के दायरे में (हर साइट और IP के लिए प्रति मिनट 60) |
webhook-inbound | भेजने वाले द्वारा हस्ताक्षरित - वेबहुक देखें |
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 पेज पर है।