端点系列
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 | 由发送方签名 - 请参阅 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 页面中介绍。