콘텐츠로 이동

엔드포인트 그룹

API는 하나의 게이트웨이(api.rolchat.com)에서 제공되며, 게이트웨이는 각 경로 그룹을 그것을 소유한 서비스로 라우팅합니다. 이 페이지는 게이트웨이가 고객에게 제공하는 모든 그룹을 모듈별로 나열합니다. 모든 그룹은 규약(봉투, 페이지네이션, 멱등성, 오류 코드)을 공유하므로, 이 표는 리소스가 어디에 있는지와 호출이 어떻게 인증되는지를 알려 줍니다.

경로는 접두사입니다. /api/v1/contacts는 GET /contacts, POST /contacts, GET /contacts/:id, PATCH /contacts/:id 등을 포함합니다. 가장 긴 접두사가 우선하므로 /kb/public 같은 공개 하위 그룹이 인증이 필요한 /kb 아래에 있을 수 있습니다.

버킷호출할 수 있는 대상
user계정 멤버 - JWT 또는 API 키, X-Account-Id 필수
login익명, 엄격한 로그인 제한(IP당 분당 10회)
unauthenticated익명
widget익명, 사이트 키와 출처로 범위 제한(사이트 및 IP당 분당 60회)
webhook-inbound보낸 쪽이 서명 - 웹훅 참고
partner파트너 JWT(파트너 포털)

Auth & account

접두사서비스버킷
/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

접두사서비스버킷
/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

접두사서비스버킷
/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

접두사서비스버킷
/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

접두사서비스버킷
/api/v1/channelschannel-serviceuser
/api/v1/widget-configschannel-serviceuser
/api/v1/widgetvisitor-servicewidget
/api/v1/webhookschannel-servicewebhook-inbound

Visitors

접두사서비스버킷
/api/v1/visitorsvisitor-serviceuser
/api/v1/geo-sourcevisitor-serviceuser
/api/v1/funnelsvisitor-serviceuser

Knowledge base

접두사서비스버킷
/api/v1/kbkb-serviceuser
/api/v1/kb/publickb-servicewidget

Marketing

접두사서비스버킷
/api/v1/marketingmarketing-serviceuser
/api/v1/marketing/publicmarketing-servicewidget
/api/v1/surveysmarketing-serviceuser
/api/v1/survey-responsesmarketing-serviceuser
/api/v1/meetingsmarketing-serviceuser

Phone

접두사서비스버킷
/api/v1/phone/twiliophone-servicewebhook-inbound
/api/v1/phonephone-serviceuser

Automation

접두사서비스버킷
/api/v1/automationautomation-serviceuser

Reports

접두사서비스버킷
/api/v1/reportsanalytics-serviceuser
/api/v1/dashboardsanalytics-serviceuser
/api/v1/kpianalytics-serviceuser
접두사서비스버킷
/api/v1/consentprivacy-servicewidget
/api/v1/privacyprivacy-serviceuser
/api/v1/privacy/publicprivacy-servicewidget

AI

접두사서비스버킷
/api/v1/aiplugin-serviceuser · 60초 시간 제한
/api/v1/ai/assistant/replyplugin-servicewebhook-inbound

Notifications

접두사서비스버킷
/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

접두사서비스버킷
/api/v1/mediamedia-serviceuser

Billing

접두사서비스버킷
/api/v1/billingbilling-serviceuser
/api/v1/billing/webhooks/stripebilling-servicewebhook-inbound

Partner portal

접두사서비스버킷
/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)

접두사서비스버킷
/api/v1/kyc/webhooks/sumsubkyc-servicewebhook-inbound
/api/v1/kyc/webhooks/didwwkyc-servicewebhook-inbound
/api/v1/kyckyc-serviceuser

기타

접두사서비스버킷
/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

이 표는 백엔드 저장소에 있는 게이트웨이의 라우트 테이블에서 생성되어 이 사이트에 스냅숏으로 들어옵니다. 배포할 때마다 스냅숏을 현재 라우트 테이블과 비교하는 검사가 실행되므로, 이 페이지가 바뀌지 않은 채 제품에서 그룹이 추가되거나 제거될 수 없습니다. 내부 직원 콘솔 경로는 제외됩니다. 기계 판독 가능한 OpenAPI 문서는 OpenAPI 페이지에서 설명합니다.