इसे छोड़कर कंटेंट पर जाएं

एंडपॉइंट फ़ैमिली

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 (पार्टनर पोर्टल)

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

सूची कहाँ से आती है

Section titled “सूची कहाँ से आती है”

यह टेबल बैकएंड रिपॉज़िटरी में गेटवे की रूट टेबल से बनती है, जिसका स्नैपशॉट इस साइट में रखा जाता है। हर डिप्लॉय से पहले एक जाँच स्नैपशॉट की तुलना मौजूदा रूट टेबल से करती है, इसलिए इस पेज के बदले बिना उत्पाद में कोई फ़ैमिली जोड़ी या हटाई नहीं जा सकती। आंतरिक स्टाफ़-कंसोल रूट शामिल नहीं हैं। मशीन-पठनीय OpenAPI दस्तावेज़ का विवरण OpenAPI पेज पर है।