Siirry sisältöön

Päätepisteperheet

API:a tarjoaa yksi yhdyskäytävä (api.rolchat.com), joka ohjaa kunkin polkuperheen sen omistavalle palvelulle. Tämä sivu luettelee jokaisen perheen, jonka yhdyskäytävä tarjoaa asiakkaille, moduuleittain ryhmiteltynä. Kaikki perheet noudattavat samoja käytäntöjä - kirjekuori, sivutus, idempotenssi, virhekoodit - joten taulukko kertoo, missä resurssi sijaitsee ja miten kutsu todennetaan.

Polut ovat etuliitteitä: /api/v1/contacts kattaa GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id ja niin edelleen. Pisin etuliite voittaa, minkä vuoksi julkinen alaperhe, kuten /kb/public, voi olla todennetun /kb-perheen alla.

LuokkaKuka saa kutsua
userTilin jäsen - JWT tai API-avain, X-Account-Id pakollinen
loginAnonyymi, tiukat kirjautumisrajat (10 IP-osoitetta kohden minuutissa)
unauthenticatedAnonyymi
widgetAnonyymi, rajattu sivustoavaimen ja alkuperän mukaan (60 sivustoa ja IP-osoitetta kohden minuutissa)
webhook-inboundLähettäjän allekirjoittama - katso Webhookit
partnerKumppanin JWT (kumppaniportaali)

Todennus ja tili

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

Keskustelut ja postilaatikko

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

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

Tiketit

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

Kanavat ja widget

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

Vierailijat

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

Tietopankki

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

Markkinointi

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

Puhelin

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

Automaatio

EtuliitePalveluLuokka
/api/v1/automationautomation-serviceuser

Raportit

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

AI

EtuliitePalveluLuokka
/api/v1/aiplugin-serviceuser · 60 s:n aikakatkaisu
/api/v1/ai/assistant/replyplugin-servicewebhook-inbound

Ilmoitukset

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

EtuliitePalveluLuokka
/api/v1/mediamedia-serviceuser

Laskutus

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

Kumppaniportaali

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

Henkilöllisyyden todentaminen (KYC)

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

Muut

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

Tämä taulukko luodaan taustajärjestelmän repositorion yhdyskäytävän reittitaulukosta, josta on otettu tilannekuva tälle sivustolle. Ennen jokaista julkaisua tehtävä tarkistus vertaa tilannekuvaa nykyiseen reittitaulukkoon, joten perhettä ei voi lisätä tuotteeseen tai poistaa siitä ilman, että tämä sivu muuttuu. Henkilökunnan sisäisen konsolin reitit on jätetty pois. Koneluettava OpenAPI-dokumentti kuvataan sivulla OpenAPI.