Gå til indhold

Endpoint-familier

API’et leveres af én gateway (api.rolchat.com), der sender hver stifamilie videre til den tjeneste, der ejer den. Denne side viser alle familier, som gatewayen udstiller til kunder, grupperet efter modul. Alle familier deler de samme konventioner - konvolut, paginering, idempotens, fejlkoder - så tabellen fortæller dig, hvor en ressource ligger, og hvordan kaldet godkendes.

Stierne er præfikser: /api/v1/contacts dækker GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id og så videre. Det længste præfiks vinder, og derfor kan en offentlig underfamilie som /kb/public ligge under en godkendt /kb.

GruppeHvem må kalde
userKontomedlem - JWT eller API-nøgle, X-Account-Id påkrævet
loginAnonym, strenge loginbegrænsninger (10 pr. IP pr. minut)
unauthenticatedAnonym
widgetAnonym, afgrænset af webstedsnøgle og oprindelse (60 pr. websted og IP pr. minut)
webhook-inboundSigneret af afsenderen - se Webhooks
partnerPartner-JWT (partnerportal)

Auth & account

PræfiksTjenesteGruppe
/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

PræfiksTjenesteGruppe
/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

PræfiksTjenesteGruppe
/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

PræfiksTjenesteGruppe
/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

PræfiksTjenesteGruppe
/api/v1/channelschannel-serviceuser
/api/v1/widget-configschannel-serviceuser
/api/v1/widgetvisitor-servicewidget
/api/v1/webhookschannel-servicewebhook-inbound

Visitors

PræfiksTjenesteGruppe
/api/v1/visitorsvisitor-serviceuser
/api/v1/geo-sourcevisitor-serviceuser
/api/v1/funnelsvisitor-serviceuser

Knowledge base

PræfiksTjenesteGruppe
/api/v1/kbkb-serviceuser
/api/v1/kb/publickb-servicewidget

Marketing

PræfiksTjenesteGruppe
/api/v1/marketingmarketing-serviceuser
/api/v1/marketing/publicmarketing-servicewidget
/api/v1/surveysmarketing-serviceuser
/api/v1/survey-responsesmarketing-serviceuser
/api/v1/meetingsmarketing-serviceuser

Phone

PræfiksTjenesteGruppe
/api/v1/phone/twiliophone-servicewebhook-inbound
/api/v1/phonephone-serviceuser

Automation

PræfiksTjenesteGruppe
/api/v1/automationautomation-serviceuser

Reports

PræfiksTjenesteGruppe
/api/v1/reportsanalytics-serviceuser
/api/v1/dashboardsanalytics-serviceuser
/api/v1/kpianalytics-serviceuser
PræfiksTjenesteGruppe
/api/v1/consentprivacy-servicewidget
/api/v1/privacyprivacy-serviceuser
/api/v1/privacy/publicprivacy-servicewidget

AI

PræfiksTjenesteGruppe
/api/v1/aiplugin-serviceuser · 60 s timeout
/api/v1/ai/assistant/replyplugin-servicewebhook-inbound

Notifications

PræfiksTjenesteGruppe
/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

PræfiksTjenesteGruppe
/api/v1/mediamedia-serviceuser

Billing

PræfiksTjenesteGruppe
/api/v1/billingbilling-serviceuser
/api/v1/billing/webhooks/stripebilling-servicewebhook-inbound

Partner portal

PræfiksTjenesteGruppe
/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)

PræfiksTjenesteGruppe
/api/v1/kyc/webhooks/sumsubkyc-servicewebhook-inbound
/api/v1/kyc/webhooks/didwwkyc-servicewebhook-inbound
/api/v1/kyckyc-serviceuser

Andre

PræfiksTjenesteGruppe
/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 genereres ud fra gatewayens rutetabel i backend-repositoriet og gemmes som et øjebliksbillede på dette site. En kontrol før hver udrulning sammenligner øjebliksbilledet med den aktuelle rutetabel, så en familie ikke kan tilføjes eller fjernes i produktet, uden at denne side ændres. Interne ruter til medarbejderkonsollen er udeladt. Det maskinlæsbare OpenAPI-dokument beskrives på siden OpenAPI.