Hoppa till innehåll

Endpoint-familjer

API:et levereras av en enda gateway (api.rolchat.com) som routar varje sökvägsfamilj till den tjänst som äger den. Den här sidan listar varje familj som gatewayen exponerar för kunder, grupperad per modul. Alla familjer delar samma konventioner - omslag, paginering, idempotens, felkoder - så tabellen visar var en resurs finns och hur anropet autentiseras.

Sökvägarna är prefix: /api/v1/contacts omfattar GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id och så vidare. Det längsta prefixet vinner, vilket är varför en publik underfamilj som /kb/public kan ligga under en autentiserad /kb.

GruppVem får anropa
userKontomedlem - JWT eller API-nyckel, X-Account-Id krävs
loginAnonym, strikta inloggningsgränser (10 per IP-adress och minut)
unauthenticatedAnonym
widgetAnonym, avgränsad av webbplatsnyckel och ursprung (60 per webbplats och IP-adress och minut)
webhook-inboundSignerad av avsändaren - se Webhooks
partnerPartner-JWT (partnerportalen)

Autentisering och konto

PrefixTjänstGrupp
/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

Konversationer och inkorg

PrefixTjänstGrupp
/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

PrefixTjänstGrupp
/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

Ärenden

PrefixTjänstGrupp
/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

Kanaler och widget

PrefixTjänstGrupp
/api/v1/channelschannel-serviceuser
/api/v1/widget-configschannel-serviceuser
/api/v1/widgetvisitor-servicewidget
/api/v1/webhookschannel-servicewebhook-inbound

Besökare

PrefixTjänstGrupp
/api/v1/visitorsvisitor-serviceuser
/api/v1/geo-sourcevisitor-serviceuser
/api/v1/funnelsvisitor-serviceuser

Kunskapsbas

PrefixTjänstGrupp
/api/v1/kbkb-serviceuser
/api/v1/kb/publickb-servicewidget

Marknadsföring

PrefixTjänstGrupp
/api/v1/marketingmarketing-serviceuser
/api/v1/marketing/publicmarketing-servicewidget
/api/v1/surveysmarketing-serviceuser
/api/v1/survey-responsesmarketing-serviceuser
/api/v1/meetingsmarketing-serviceuser

Telefon

PrefixTjänstGrupp
/api/v1/phone/twiliophone-servicewebhook-inbound
/api/v1/phonephone-serviceuser

Automatisering

PrefixTjänstGrupp
/api/v1/automationautomation-serviceuser

Rapporter

PrefixTjänstGrupp
/api/v1/reportsanalytics-serviceuser
/api/v1/dashboardsanalytics-serviceuser
/api/v1/kpianalytics-serviceuser
PrefixTjänstGrupp
/api/v1/consentprivacy-servicewidget
/api/v1/privacyprivacy-serviceuser
/api/v1/privacy/publicprivacy-servicewidget

AI

PrefixTjänstGrupp
/api/v1/aiplugin-serviceuser · tidsgräns 60 s
/api/v1/ai/assistant/replyplugin-servicewebhook-inbound

Aviseringar

PrefixTjänstGrupp
/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

PrefixTjänstGrupp
/api/v1/mediamedia-serviceuser

Fakturering

PrefixTjänstGrupp
/api/v1/billingbilling-serviceuser
/api/v1/billing/webhooks/stripebilling-servicewebhook-inbound

Partnerportal

PrefixTjänstGrupp
/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

Identitetsverifiering (KYC)

PrefixTjänstGrupp
/api/v1/kyc/webhooks/sumsubkyc-servicewebhook-inbound
/api/v1/kyc/webhooks/didwwkyc-servicewebhook-inbound
/api/v1/kyckyc-serviceuser

Övrigt

PrefixTjänstGrupp
/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

Tabellen genereras från gatewayens routningstabell i backend-repot och sparas som en ögonblicksbild på den här webbplatsen. En kontroll före varje driftsättning jämför ögonblicksbilden med den aktuella routningstabellen, så att en familj inte kan läggas till eller tas bort i produkten utan att den här sidan ändras. Interna routes för personalkonsolen är undantagna. Det maskinläsbara OpenAPI-dokumentet beskrivs på sidan OpenAPI.