İçeriğe geç

Endpoint aileleri

API, her yol ailesini ona sahip olan servise yönlendiren tek bir ağ geçidi (api.rolchat.com) üzerinden sunulur. Bu sayfa, ağ geçidinin müşterilere açtığı her aileyi modüle göre gruplanmış olarak listeler. Tüm aileler aynı kuralları paylaşır - zarf, sayfalama, idempotency, hata kodları - bu nedenle tablo size bir kaynağın nerede bulunduğunu ve çağrının kimliğinin nasıl doğrulandığını söyler.

Yollar öneklerdir: /api/v1/contacts; GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id vb. yolları kapsar. En uzun önek kazanır; bu yüzden /kb/public gibi herkese açık bir alt aile, kimlik doğrulamalı bir /kb altında yer alabilir.

GrupKimler çağırabilir
userAccount member - JWT or API key, X-Account-Id required
loginAnonymous, strict sign-in limits (10 per IP per minute)
unauthenticatedAnonymous
widgetAnonymous, scoped by site key and origin (60 per site and IP per minute)
webhook-inboundSigned by the sender - see Webhooks
partnerPartner JWT (partner portal)

Auth & account

PrefixServiceBucket
/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

PrefixServiceBucket
/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

PrefixServiceBucket
/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

PrefixServiceBucket
/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

PrefixServiceBucket
/api/v1/channelschannel-serviceuser
/api/v1/widget-configschannel-serviceuser
/api/v1/widgetvisitor-servicewidget
/api/v1/webhookschannel-servicewebhook-inbound

Visitors

PrefixServiceBucket
/api/v1/visitorsvisitor-serviceuser
/api/v1/geo-sourcevisitor-serviceuser
/api/v1/funnelsvisitor-serviceuser

Knowledge base

PrefixServiceBucket
/api/v1/kbkb-serviceuser
/api/v1/kb/publickb-servicewidget

Marketing

PrefixServiceBucket
/api/v1/marketingmarketing-serviceuser
/api/v1/marketing/publicmarketing-servicewidget
/api/v1/surveysmarketing-serviceuser
/api/v1/survey-responsesmarketing-serviceuser
/api/v1/meetingsmarketing-serviceuser

Phone

PrefixServiceBucket
/api/v1/phone/twiliophone-servicewebhook-inbound
/api/v1/phonephone-serviceuser

Automation

PrefixServiceBucket
/api/v1/automationautomation-serviceuser

Reports

PrefixServiceBucket
/api/v1/reportsanalytics-serviceuser
/api/v1/dashboardsanalytics-serviceuser
/api/v1/kpianalytics-serviceuser
PrefixServiceBucket
/api/v1/consentprivacy-servicewidget
/api/v1/privacyprivacy-serviceuser
/api/v1/privacy/publicprivacy-servicewidget

AI

PrefixServiceBucket
/api/v1/aiplugin-serviceuser · 60 s timeout
/api/v1/ai/assistant/replyplugin-servicewebhook-inbound

Notifications

PrefixServiceBucket
/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

PrefixServiceBucket
/api/v1/mediamedia-serviceuser

Billing

PrefixServiceBucket
/api/v1/billingbilling-serviceuser
/api/v1/billing/webhooks/stripebilling-servicewebhook-inbound

Partner portal

PrefixServiceBucket
/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)

PrefixServiceBucket
/api/v1/kyc/webhooks/sumsubkyc-servicewebhook-inbound
/api/v1/kyc/webhooks/didwwkyc-servicewebhook-inbound
/api/v1/kyckyc-serviceuser

Other

PrefixServiceBucket
/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

Bu tablo, backend deposundaki ağ geçidi yönlendirme tablosundan oluşturulur ve bu siteye anlık görüntü olarak alınır. Her dağıtımdan önce yapılan bir kontrol, anlık görüntüyü güncel yönlendirme tablosuyla karşılaştırır; böylece bu sayfa değişmeden üründe bir aile eklenemez veya kaldırılamaz. Dahili personel konsolu yolları hariç tutulur. Makinece okunabilir OpenAPI belgesi OpenAPI sayfasında açıklanmıştır.