Gå til innholdet

Endepunktfamilier

API-et leveres av én gateway (api.rolchat.com) som ruter hver stifamilie til tjenesten som eier den. Denne siden viser alle familier gatewayen eksponerer for kunder, gruppert etter modul. Alle familier følger de samme konvensjonene - konvolutt, paginering, idempotens, feilkoder - så tabellen forteller deg hvor en ressurs befinner seg og hvordan kallet autentiseres.

Stiene er prefikser: /api/v1/contacts dekker GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id og så videre. Det lengste prefikset vinner, og derfor kan en offentlig underfamilie som /kb/public ligge under en autentisert /kb.

GruppeHvem kan kalle
userKontomedlem - JWT eller API-nøkkel, X-Account-Id påkrevd
loginAnonym, strenge innloggingsgrenser (10 per IP per minutt)
unauthenticatedAnonym
widgetAnonym, avgrenset av nettstedsnøkkel og opprinnelse (60 per nettsted og IP per minutt)
webhook-inboundSignert av avsenderen - se Webhooks
partnerPartner-JWT (partnerportal)

Autentisering og konto

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

Samtaler og innboks

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

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

Saker

PrefiksTjenesteGruppe
/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 og widget

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

Besøkende

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

Kunnskapsbase

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

Markedsføring

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

Telefon

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

Automatisering

PrefiksTjenesteGruppe
/api/v1/automationautomation-serviceuser

Rapporter

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

AI

PrefiksTjenesteGruppe
/api/v1/aiplugin-serviceuser · tidsavbrudd 60 s
/api/v1/ai/assistant/replyplugin-servicewebhook-inbound

Varsler

PrefiksTjenesteGruppe
/api/v1/notifications-policynotification-serviceuser
/api/v1/notificationsnotification-serviceuser
/api/v1/notification-templatesnotification-serviceuser
/api/v1/notification-delivery-logsnotification-serviceuser
/api/v1/pushnotification-serviceuser

Medier

PrefiksTjenesteGruppe
/api/v1/mediamedia-serviceuser

Fakturering

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

Partnerportal

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

Identitetsverifisering (KYC)

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

Annet

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

Denne tabellen genereres fra gatewayens rutetabell i backend-repositoriet, som et øyeblikksbilde lagret på dette nettstedet. En kontroll før hver utrulling sammenligner øyeblikksbildet med den gjeldende rutetabellen, så en familie kan ikke legges til eller fjernes i produktet uten at denne siden endres. Interne ruter for personalkonsollen er utelatt. Det maskinlesbare OpenAPI-dokumentet er beskrevet på OpenAPI-siden.