エンドポイントファミリー

API は1つのゲートウェイ（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 ごとに1分あたり10回）
unauthenticated	匿名
widget	匿名、サイトキーとオリジンで範囲を限定（サイトと IP ごとに1分あたり60回）
webhook-inbound	送信元が署名 - Webhook を参照
partner	パートナー JWT（パートナーポータル）

ファミリー

Auth & account

プレフィックス	サービス	バケット
/api/v1/auth	iam-service	login
/api/v1/captcha	iam-service	unauthenticated
/api/v1/me	iam-service	user
/api/v1/accounts	iam-service	user
/api/v1/account-settings	iam-service	user
/api/v1/users	iam-service	user
/api/v1/members	iam-service	user
/api/v1/roles	iam-service	user
/api/v1/tokens	iam-service	user
/api/v1/staff-access-policy	iam-service	user
/api/v1/staff-access-sessions	iam-service	user
/api/v1/presence	iam-service	user
/api/v1/workforce	iam-service	user
/api/v1/sites	sites-service	user
/api/v1/profile	profile-service	user
/api/v1/teams	teams-service	user
/api/v1/audit	audit-service	user

Conversations & inbox

プレフィックス	サービス	バケット
/api/v1/conversations	conversation-service	user
/api/v1/messages	conversation-service	user
/api/v1/conversation-tags	conversation-service	user
/api/v1/inboxes	conversation-service	user
/api/v1/views	conversation-service	user
/api/v1/templates	conversation-service	user
/api/v1/chat-routing-rules	conversation-service	user
/api/v1/macros	conversation-service	user
/api/v1/chat-settings	conversation-service	user
/api/v1/tasks	conversation-service	user

CRM

プレフィックス	サービス	バケット
/api/v1/leads	crm-service	user
/api/v1/contacts	crm-service	user
/api/v1/companies	crm-service	user
/api/v1/deals	crm-service	user
/api/v1/pipelines	crm-service	user
/api/v1/lead-statuses	crm-service	user
/api/v1/contact-tags	crm-service	user
/api/v1/segments	crm-service	user
/api/v1/lead-routing-rules	crm-service	user
/api/v1/crm-settings	crm-service	user
/api/v1/crm/campaigns	crm-service	user
/api/v1/custom-fields	meta-service	user

Tickets

プレフィックス	サービス	バケット
/api/v1/tickets	ticket-service	user
/api/v1/ticket-queues	ticket-service	user
/api/v1/ticket-settings	ticket-service	user
/api/v1/ticket-sla-policies	ticket-service	user
/api/v1/ticket-custom-fields	ticket-service	user
/api/v1/ticket-tags	ticket-service	user

Channels & widget

プレフィックス	サービス	バケット
/api/v1/channels	channel-service	user
/api/v1/widget-configs	channel-service	user
/api/v1/widget	visitor-service	widget
/api/v1/webhooks	channel-service	webhook-inbound

Visitors

プレフィックス	サービス	バケット
/api/v1/visitors	visitor-service	user
/api/v1/geo-source	visitor-service	user
/api/v1/funnels	visitor-service	user

Knowledge base

プレフィックス	サービス	バケット
/api/v1/kb	kb-service	user
/api/v1/kb/public	kb-service	widget

Marketing

プレフィックス	サービス	バケット
/api/v1/marketing	marketing-service	user
/api/v1/marketing/public	marketing-service	widget
/api/v1/surveys	marketing-service	user
/api/v1/survey-responses	marketing-service	user
/api/v1/meetings	marketing-service	user

Phone

プレフィックス	サービス	バケット
/api/v1/phone/twilio	phone-service	webhook-inbound
/api/v1/phone	phone-service	user

Automation

プレフィックス	サービス	バケット
/api/v1/automation	automation-service	user

Reports

プレフィックス	サービス	バケット
/api/v1/reports	analytics-service	user
/api/v1/dashboards	analytics-service	user
/api/v1/kpi	analytics-service	user

Privacy & consent

プレフィックス	サービス	バケット
/api/v1/consent	privacy-service	widget
/api/v1/privacy	privacy-service	user
/api/v1/privacy/public	privacy-service	widget

AI

プレフィックス	サービス	バケット
/api/v1/ai	plugin-service	user · タイムアウト 60 秒
/api/v1/ai/assistant/reply	plugin-service	webhook-inbound

Notifications

プレフィックス	サービス	バケット
/api/v1/notifications-policy	notification-service	user
/api/v1/notifications	notification-service	user
/api/v1/notification-templates	notification-service	user
/api/v1/notification-delivery-logs	notification-service	user
/api/v1/push	notification-service	user

Media

プレフィックス	サービス	バケット
/api/v1/media	media-service	user

Billing

プレフィックス	サービス	バケット
/api/v1/billing	billing-service	user
/api/v1/billing/webhooks/stripe	billing-service	webhook-inbound

Partner portal

プレフィックス	サービス	バケット
/api/v1/partner	partner-portal-service	partner
/api/v1/partner/auth	iam-service	login
/api/v1/partner/invitations	partner-portal-service	login
/api/v1/partner/auth/mfa/enroll	iam-service	partner
/api/v1/partner/auth/mfa/confirm	iam-service	partner
/api/v1/partner/auth/step-up	iam-service	partner
/api/v1/r	partner-portal-service	widget

Identity verification (KYC)

プレフィックス	サービス	バケット
/api/v1/kyc/webhooks/sumsub	kyc-service	webhook-inbound
/api/v1/kyc/webhooks/didww	kyc-service	webhook-inbound
/api/v1/kyc	kyc-service	user

その他

プレフィックス	サービス	バケット
/api/v1/auth/me	iam-service	user
/api/v1/auth/sessions	iam-service	user
/api/v1/auth/mfa	iam-service	user
/api/v1/auth/email-change	iam-service	user
/api/v1/auth/swap-company	iam-service	user
/api/v1/privacy/policies	privacy-service	user
/api/v1/compliance	privacy-service	user
/api/v1/identity-graph	identity-graph-service	user

この一覧の出典

この表は、バックエンドリポジトリにあるゲートウェイのルートテーブルから生成され、スナップショットとしてこのサイトに取り込まれています。デプロイのたびに、スナップショットと現在のルートテーブルを比較するチェックが実行されるため、このページが変わらないまま製品でファミリーが追加・削除されることはありません。社内スタッフ用コンソールのルートは除外されています。機械可読な OpenAPI ドキュメントについては OpenAPI のページで説明しています。