Tovább a tartalomhoz

Végpontcsaládok

Az API-t egyetlen átjáró (api.rolchat.com) szolgálja ki, amely minden útvonalcsaládot a hozzá tartozó szolgáltatáshoz irányít. Ez az oldal modulok szerint csoportosítva felsorolja az átjáró által az ügyfelek számára elérhetővé tett összes családot. Minden család ugyanazokat a konvenciókat követi - boríték, lapozás, idempotencia, hibakódok -, így a táblázat azt mutatja meg, hol található egy erőforrás, és hogyan hitelesítjük a hívást.

Az útvonalak előtagok: a /api/v1/contacts lefedi a GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id stb. hívásokat. A leghosszabb előtag nyer, ezért helyezkedhet el egy nyilvános alcsalád, például a /kb/public, egy hitelesített /kb alatt.

KategóriaKi hívhatja
userFióktag - JWT vagy API-kulcs, X-Account-Id kötelező
loginNévtelen, szigorú bejelentkezési korlátokkal (IP-címenként percenként 10)
unauthenticatedNévtelen
widgetNévtelen, webhelykulcs és eredet szerint korlátozva (webhelyenként és IP-címenként percenként 60)
webhook-inboundA küldő által aláírva - lásd: Webhookok
partnerPartner JWT (partnerportál)

Hitelesítés és fiók

ElőtagSzolgáltatásKategória
/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

Beszélgetések és beérkezett üzenetek

ElőtagSzolgáltatásKategória
/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

ElőtagSzolgáltatásKategória
/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

Jegyek

ElőtagSzolgáltatásKategória
/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

Csatornák és widget

ElőtagSzolgáltatásKategória
/api/v1/channelschannel-serviceuser
/api/v1/widget-configschannel-serviceuser
/api/v1/widgetvisitor-servicewidget
/api/v1/webhookschannel-servicewebhook-inbound

Látogatók

ElőtagSzolgáltatásKategória
/api/v1/visitorsvisitor-serviceuser
/api/v1/geo-sourcevisitor-serviceuser
/api/v1/funnelsvisitor-serviceuser

Tudásbázis

ElőtagSzolgáltatásKategória
/api/v1/kbkb-serviceuser
/api/v1/kb/publickb-servicewidget

Marketing

ElőtagSzolgáltatásKategória
/api/v1/marketingmarketing-serviceuser
/api/v1/marketing/publicmarketing-servicewidget
/api/v1/surveysmarketing-serviceuser
/api/v1/survey-responsesmarketing-serviceuser
/api/v1/meetingsmarketing-serviceuser

Telefon

ElőtagSzolgáltatásKategória
/api/v1/phone/twiliophone-servicewebhook-inbound
/api/v1/phonephone-serviceuser

Automatizálás

ElőtagSzolgáltatásKategória
/api/v1/automationautomation-serviceuser

Jelentések

ElőtagSzolgáltatásKategória
/api/v1/reportsanalytics-serviceuser
/api/v1/dashboardsanalytics-serviceuser
/api/v1/kpianalytics-serviceuser
ElőtagSzolgáltatásKategória
/api/v1/consentprivacy-servicewidget
/api/v1/privacyprivacy-serviceuser
/api/v1/privacy/publicprivacy-servicewidget

AI

ElőtagSzolgáltatásKategória
/api/v1/aiplugin-serviceuser · 60 s időkorlát
/api/v1/ai/assistant/replyplugin-servicewebhook-inbound

Értesítések

ElőtagSzolgáltatásKategória
/api/v1/notifications-policynotification-serviceuser
/api/v1/notificationsnotification-serviceuser
/api/v1/notification-templatesnotification-serviceuser
/api/v1/notification-delivery-logsnotification-serviceuser
/api/v1/pushnotification-serviceuser

Média

ElőtagSzolgáltatásKategória
/api/v1/mediamedia-serviceuser

Számlázás

ElőtagSzolgáltatásKategória
/api/v1/billingbilling-serviceuser
/api/v1/billing/webhooks/stripebilling-servicewebhook-inbound

Partnerportál

ElőtagSzolgáltatásKategória
/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

Személyazonosság-ellenőrzés (KYC)

ElőtagSzolgáltatásKategória
/api/v1/kyc/webhooks/sumsubkyc-servicewebhook-inbound
/api/v1/kyc/webhooks/didwwkyc-servicewebhook-inbound
/api/v1/kyckyc-serviceuser

Egyéb

ElőtagSzolgáltatásKategória
/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

Ez a táblázat a backend-tárolóban lévő átjáró útvonaltáblájából készül, amelynek pillanatképe ebbe a webhelybe kerül. Minden telepítés előtt egy ellenőrzés összeveti a pillanatképet az aktuális útvonaltáblával, így a termékben egyetlen család sem adható hozzá vagy távolítható el anélkül, hogy ez az oldal megváltozna. A belső munkatársi konzol útvonalai nem szerepelnek. A gép által olvasható OpenAPI-dokumentum leírása az OpenAPI oldalon található.