Sari la conținut

Familii de endpointuri

API-ul este servit de un singur gateway (api.rolchat.com) care direcționează fiecare familie de căi către serviciul care o deține. Această pagină listează fiecare familie pe care gateway-ul o expune clienților, grupată pe module. Toate familiile respectă aceleași convenții - structura răspunsului, paginare, idempotență, coduri de eroare - așa că tabelul îți spune unde se află o resursă și cum este autentificat apelul.

Căile sunt prefixe: /api/v1/contacts acoperă GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id și așa mai departe. Câștigă prefixul cel mai lung, motiv pentru care o subfamilie publică precum /kb/public se poate afla sub un /kb autentificat.

CategorieCine poate apela
userMembru al contului - JWT sau cheie API, X-Account-Id obligatoriu
loginAnonim, limite stricte de autentificare (10 pe minut per IP)
unauthenticatedAnonim
widgetAnonim, limitat după cheia site-ului și origine (60 pe minut per site și IP)
webhook-inboundSemnat de expeditor - vezi Webhook-uri
partnerJWT de partener (portalul partenerilor)

Auth & account

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

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

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

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

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

Visitors

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

Knowledge base

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

Marketing

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

Phone

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

Automation

PrefixServiciuCategorie
/api/v1/automationautomation-serviceuser

Reports

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

AI

PrefixServiciuCategorie
/api/v1/aiplugin-serviceuser · timp limită 60 s
/api/v1/ai/assistant/replyplugin-servicewebhook-inbound

Notifications

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

PrefixServiciuCategorie
/api/v1/mediamedia-serviceuser

Billing

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

Partner portal

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

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

Altele

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

Acest tabel este generat din tabelul de rute al gateway-ului din depozitul backend, preluat ca instantaneu în acest site. O verificare înainte de fiecare lansare compară instantaneul cu tabelul de rute curent, așa că o familie nu poate fi adăugată sau eliminată din produs fără ca această pagină să se schimbe. Rutele interne ale consolei personalului sunt excluse. Documentul OpenAPI care poate fi citit automat este descris pe pagina OpenAPI.