接口文档

集中查阅当前站点真实可用的接口文档与契约。

OpenAPI 真源

API 文档直接读取已实现接口

页面上的版本号、路径数量、接口分组和下载入口都来自同一份 OpenAPI YAML,不再手写摘要页。

v2.6.0

lili520.com OpenAPI

只展示已经真实落地、可联调、可回归的本站接口。

Single source of truth for implemented BFF routes.

文档版本

v2.6.0

路径数

113

操作数

127

对外可见入口

部署后可以直接从页面验证契约与版本。

下载 OpenAPI查看版本指纹

只有真实存在的本地 BFF 路由才会进入文档,preview 模块不会伪装成已接通接口。

环境

联调地址

联调前先确认实际 base URL。

正式环境

https://api.lili520.com

测试环境

https://api-test.lili520.com

认证

安全方案

最终认证方案以 OpenAPI securitySchemes 为准。

Bearer JWT

Bearer auth or dev fallback session context.

类型: http · 协议: bearer

OAuth 2.0

OAuth 2.0 authorization code flow for Gmail and third-party integrations.

类型: oauth2

流程: 授权码:2 个 scope,支持刷新令牌

主闭环

发送、回执、归档、导出

这四个接口是当前主业务闭环的关键联调入口。

POST/api/outreach/receipt

Write receipt event

Send and receipt

POST/api/outreach/send

Send outreach

Send and receipt

POST/api/crm/archive

Archive lead to CRM

Archive APIs

GET/api/export/crm

Export CRM data

Export APIs

高级功能

已接通的高级模块接口

调度、搜索、实时通信、数据大屏、洞察、合规、权限、国际化、主题、移动端、快捷键、引导和反馈都从这里可见。

GET/api/channel-accounts

Get all channel accounts

Gmail、WhatsApp、通道发送与回写

GET/api/channel-accounts/gmail/callback

Complete Gmail OAuth callback

Gmail、WhatsApp、通道发送与回写

POST/api/channel-accounts/gmail/connect

Start Gmail OAuth connect

Gmail、WhatsApp、通道发送与回写

GET/api/channel-accounts/gmail/status

Get Gmail account pool status

Gmail、WhatsApp、通道发送与回写

GET/api/channel-accounts/whatsapp/callback

Verify WhatsApp callback

Gmail、WhatsApp、通道发送与回写

POST/api/channel-accounts/whatsapp/callback

Write back WhatsApp callback event

Gmail、WhatsApp、通道发送与回写

POST/api/channel-accounts/whatsapp/connect

Connect WhatsApp business channel

Gmail、WhatsApp、通道发送与回写

GET/api/channel-accounts/whatsapp/status

Get WhatsApp channel pool status

Gmail、WhatsApp、通道发送与回写

POST/api/channel-events/writeback

Write back normalized channel event

Gmail、WhatsApp、通道发送与回写

POST/api/channel-send/execute

Execute integrated channel send

Gmail、WhatsApp、通道发送与回写

POST/api/channel-send/gmail/execute

Execute Gmail pool send

Gmail、WhatsApp、通道发送与回写

POST/api/channel-send/gmail/test

Test Gmail pool send

Gmail、WhatsApp、通道发送与回写

POST/api/channel-send/prepare

Prepare integrated channel send

Gmail、WhatsApp、通道发送与回写

POST/api/channel-send/test

Execute channel test send

Gmail、WhatsApp、通道发送与回写

POST/api/channel-send/whatsapp/execute

Execute WhatsApp pool send

Gmail、WhatsApp、通道发送与回写

POST/api/channel-send/whatsapp/test

Test WhatsApp pool send

Gmail、WhatsApp、通道发送与回写

GET/api/channels/gmail/callback

Complete legacy Gmail callback

Gmail、WhatsApp、通道发送与回写

POST/api/channels/gmail/connect

Start legacy Gmail connect

Gmail、WhatsApp、通道发送与回写

POST/api/channels/gmail/send

Send via legacy Gmail path

Gmail、WhatsApp、通道发送与回写

GET/api/channels/gmail/status

Get legacy Gmail status

Gmail、WhatsApp、通道发送与回写

GET/api/channels/health

Get legacy channel health

Gmail、WhatsApp、通道发送与回写

GET/api/channels/whatsapp/callback

Verify legacy WhatsApp callback

Gmail、WhatsApp、通道发送与回写

POST/api/channels/whatsapp/callback

Write legacy WhatsApp callback

Gmail、WhatsApp、通道发送与回写

POST/api/channels/whatsapp/connect

Refresh legacy WhatsApp status

Gmail、WhatsApp、通道发送与回写

POST/api/channels/whatsapp/send

Send via legacy WhatsApp path

Gmail、WhatsApp、通道发送与回写

GET/api/channels/whatsapp/status

Get legacy WhatsApp status

Gmail、WhatsApp、通道发送与回写

GET/api/sender-pools

Get sender pools

Sender pool management

POST/api/sender-pools

Create sender pool

Sender pool management

GET/api/channel-routing/recommendation

Get routing recommendation

Routing rules and recommendations

GET/api/routing-rules

Get routing rules

Routing rules and recommendations

POST/api/routing-rules

Create routing rule

Routing rules and recommendations

GET/api/channel-health/summary

Get channel health summary

Channel health summary

GET/api/channel-logs/delivery

Get delivery logs

Delivery and reply logs

GET/api/channel-logs/reply

Get reply logs

Delivery and reply logs

GET/api/reply-console/threads

Get reply console threads

Reply AI and approval workflow

GET/api/reply-console/threads/{id}

Get reply thread detail

Reply AI and approval workflow

POST/api/reply-console/threads/{id}/approve-reply

Approve or reject reply draft

Reply AI and approval workflow

POST/api/reply-console/threads/{id}/classify

Classify reply intent

Reply AI and approval workflow

POST/api/reply-console/threads/{id}/draft-reply

Generate AI reply draft

Reply AI and approval workflow

GET/api/audit-logs

Get channel audit logs

Channel audit trail

GET/api/quality/issues

Get quality issues

Quality issues and fixes

POST/api/quality/issues/{id}/fix

Fix quality issue

Quality issues and fixes

GET/api/ai-training/jobs

Get training jobs

Training models and jobs

GET/api/ai-training/models

Get training models

Training models and jobs

POST/api/ai-training/models/{id}/pause

Pause model

Training models and jobs

POST/api/ai-training/models/{id}/retrain

Retrain model

Training models and jobs

POST/api/ai-training/models/{id}/start

Start model

Training models and jobs

GET/api/scheduler/health

Get scheduler health

Scheduler jobs and runs

GET/api/scheduler/jobs

Get scheduler jobs

Scheduler jobs and runs

POST/api/scheduler/jobs

Create scheduler job

Scheduler jobs and runs

PATCH/api/scheduler/jobs/{id}

Update scheduler job

Scheduler jobs and runs

DELETE/api/scheduler/jobs/{id}

Delete scheduler job

Scheduler jobs and runs

POST/api/scheduler/jobs/{id}/pause

Pause scheduler job

Scheduler jobs and runs

POST/api/scheduler/jobs/{id}/resume

Resume scheduler job

Scheduler jobs and runs

POST/api/scheduler/jobs/{id}/run

Run scheduler job

Scheduler jobs and runs

GET/api/scheduler/runs

Get scheduler runs

Scheduler jobs and runs

GET/api/search/health

Get search health

Search queries and saved searches

GET/api/search/history

Get search history

Search queries and saved searches

GET/api/search/query

Run search query (GET)

Search queries and saved searches

POST/api/search/query

Run search query and persist history

Search queries and saved searches

GET/api/search/saved

Get saved searches

Search queries and saved searches

POST/api/search/saved

Save search

Search queries and saved searches

DELETE/api/search/saved/{id}

Delete saved search

Search queries and saved searches

GET/api/realtime/channels

Get realtime channels

Channels and events

POST/api/realtime/connect

Connect channel

Channels and events

POST/api/realtime/disconnect

Disconnect channel

Channels and events

GET/api/realtime/events

Get realtime events

Channels and events

GET/api/realtime/health

Get realtime health

Channels and events

POST/api/realtime/test

Send realtime test event

Channels and events

GET/api/databoard/charts

Get databoard charts

Metrics and charts

GET/api/databoard/health

Get databoard health

Metrics and charts

GET/api/databoard/metrics

Get databoard metrics

Metrics and charts

POST/api/ai-insights/generate

Generate AI insight

Insight generation and history

GET/api/ai-insights/health

Get AI insight health

Insight generation and history

GET/api/ai-insights/history

Get AI insight history

Insight generation and history

GET/api/ai-insights/summary

Get latest AI insight summary

Insight generation and history

GET/api/compliance/audit-logs

Get compliance audit logs

Compliance cases and logs

GET/api/compliance/cases

Get compliance cases

Compliance cases and logs

POST/api/compliance/cases

Create compliance case

Compliance cases and logs

GET/api/compliance/health

Get compliance health

Compliance cases and logs

GET/api/permissions/audit-logs

Get permission audit logs

Roles

GET/api/permissions/grants

Get permission grants

Roles

POST/api/permissions/grants

Create permission grant

Roles

DELETE/api/permissions/grants/{id}

Delete permission grant

Roles

GET/api/permissions/health

Get permissions health

Roles

GET/api/permissions/roles

Get roles

Roles

GET/api/permissions/users

Get users

Roles

GET/api/i18n/health

Get i18n health

Locales and translations

GET/api/i18n/locales

Get locales

Locales and translations

POST/api/i18n/locales/{locale}/publish

Publish locale

Locales and translations

GET/api/i18n/publish-logs

Get publish logs

Locales and translations

GET/api/i18n/translations

Get translations

Locales and translations

GET/api/themes/current

Get current theme

Theme settings

POST/api/themes/current

Update current theme

Theme settings

GET/api/themes/health

Get themes health

Theme settings

GET/api/themes/logs

Get theme logs

Theme settings

GET/api/mobile/devices

Get mobile devices

Devices

GET/api/mobile/health

Get mobile health

Devices

GET/api/mobile/push/logs

Get mobile push logs

Devices

POST/api/mobile/push/test

Send mobile push test

Devices

GET/api/mobile/releases

Get mobile releases

Devices

GET/api/shortcuts

Get shortcuts

Shortcut configuration

POST/api/shortcuts

Create shortcut

Shortcut configuration

DELETE/api/shortcuts/{id}

Delete shortcut

Shortcut configuration

GET/api/shortcuts/health

Get shortcuts health

Shortcut configuration

GET/api/onboarding/health

Get onboarding health

Onboarding tasks

GET/api/onboarding/tasks

Get onboarding tasks

Onboarding tasks

POST/api/onboarding/tasks/{id}/complete

Complete onboarding task

Onboarding tasks

GET/api/feedback/health

Get feedback health

Feedback items and votes

GET/api/feedback/items

Get feedback items

Feedback items and votes

POST/api/feedback/items

Create feedback item

Feedback items and votes

POST/api/feedback/items/{id}/vote

Vote feedback item

Feedback items and votes

GET/api/webhooks

Get managed webhooks

Managed webhooks and logs

POST/api/webhooks

Create webhook

Managed webhooks and logs

DELETE/api/webhooks/{id}

Delete webhook

Managed webhooks and logs

GET/api/webhooks/logs

Get webhook logs

Managed webhooks and logs

POST/api/webhooks/test

Send webhook test request

Managed webhooks and logs

GET/api/capabilities

Get capability registry

Version and capability APIs

GET/api/version

Get version and runtime capabilities

Version and capability APIs

接口分组

查看全部真实接口

分组、方法、路径和摘要全部来自 OpenAPI 真源。

统一指标

Shared metrics

GET/api/metrics/overview

Get unified metrics

Shared metrics

审核

Review queue and bulk actions

POST/api/review/bulk

Bulk review

Review queue and bulk actions

GET/api/review/queue

Get review queue

Review queue and bulk actions

客户

Customer APIs

GET/api/customers

Get customers

Customer APIs

开发信触达

Send and receipt

POST/api/outreach/receipt

Write receipt event

Send and receipt

POST/api/outreach/send

Send outreach

Send and receipt

客户管理

Archive APIs

POST/api/crm/archive

Archive lead to CRM

Archive APIs

导出

Export APIs

GET/api/export/crm

Export CRM data

Export APIs

触达通道

Gmail、WhatsApp、通道发送与回写

GET/api/channel-accounts

Get all channel accounts

Gmail、WhatsApp、通道发送与回写

GET/api/channel-accounts/gmail/callback

Complete Gmail OAuth callback

Gmail、WhatsApp、通道发送与回写

POST/api/channel-accounts/gmail/connect

Start Gmail OAuth connect

Gmail、WhatsApp、通道发送与回写

GET/api/channel-accounts/gmail/status

Get Gmail account pool status

Gmail、WhatsApp、通道发送与回写

GET/api/channel-accounts/whatsapp/callback

Verify WhatsApp callback

Gmail、WhatsApp、通道发送与回写

POST/api/channel-accounts/whatsapp/callback

Write back WhatsApp callback event

Gmail、WhatsApp、通道发送与回写

POST/api/channel-accounts/whatsapp/connect

Connect WhatsApp business channel

Gmail、WhatsApp、通道发送与回写

GET/api/channel-accounts/whatsapp/status

Get WhatsApp channel pool status

Gmail、WhatsApp、通道发送与回写

POST/api/channel-events/writeback

Write back normalized channel event

Gmail、WhatsApp、通道发送与回写

POST/api/channel-send/execute

Execute integrated channel send

Gmail、WhatsApp、通道发送与回写

POST/api/channel-send/gmail/execute

Execute Gmail pool send

Gmail、WhatsApp、通道发送与回写

POST/api/channel-send/gmail/test

Test Gmail pool send

Gmail、WhatsApp、通道发送与回写

POST/api/channel-send/prepare

Prepare integrated channel send

Gmail、WhatsApp、通道发送与回写

POST/api/channel-send/test

Execute channel test send

Gmail、WhatsApp、通道发送与回写

POST/api/channel-send/whatsapp/execute

Execute WhatsApp pool send

Gmail、WhatsApp、通道发送与回写

POST/api/channel-send/whatsapp/test

Test WhatsApp pool send

Gmail、WhatsApp、通道发送与回写

GET/api/channels/gmail/callback

Complete legacy Gmail callback

Gmail、WhatsApp、通道发送与回写

POST/api/channels/gmail/connect

Start legacy Gmail connect

Gmail、WhatsApp、通道发送与回写

POST/api/channels/gmail/send

Send via legacy Gmail path

Gmail、WhatsApp、通道发送与回写

GET/api/channels/gmail/status

Get legacy Gmail status

Gmail、WhatsApp、通道发送与回写

GET/api/channels/health

Get legacy channel health

Gmail、WhatsApp、通道发送与回写

GET/api/channels/whatsapp/callback

Verify legacy WhatsApp callback

Gmail、WhatsApp、通道发送与回写

POST/api/channels/whatsapp/callback

Write legacy WhatsApp callback

Gmail、WhatsApp、通道发送与回写

POST/api/channels/whatsapp/connect

Refresh legacy WhatsApp status

Gmail、WhatsApp、通道发送与回写

POST/api/channels/whatsapp/send

Send via legacy WhatsApp path

Gmail、WhatsApp、通道发送与回写

GET/api/channels/whatsapp/status

Get legacy WhatsApp status

Gmail、WhatsApp、通道发送与回写

发送池

Sender pool management

GET/api/sender-pools

Get sender pools

Sender pool management

POST/api/sender-pools

Create sender pool

Sender pool management

路由规则

Routing rules and recommendations

GET/api/channel-routing/recommendation

Get routing recommendation

Routing rules and recommendations

GET/api/routing-rules

Get routing rules

Routing rules and recommendations

POST/api/routing-rules

Create routing rule

Routing rules and recommendations

通道健康

Channel health summary

GET/api/channel-health/summary

Get channel health summary

Channel health summary

通道日志

Delivery and reply logs

GET/api/channel-logs/delivery

Get delivery logs

Delivery and reply logs

GET/api/channel-logs/reply

Get reply logs

Delivery and reply logs

回复控制台

Reply AI and approval workflow

GET/api/reply-console/threads

Get reply console threads

Reply AI and approval workflow

GET/api/reply-console/threads/{id}

Get reply thread detail

Reply AI and approval workflow

POST/api/reply-console/threads/{id}/approve-reply

Approve or reject reply draft

Reply AI and approval workflow

POST/api/reply-console/threads/{id}/classify

Classify reply intent

Reply AI and approval workflow

POST/api/reply-console/threads/{id}/draft-reply

Generate AI reply draft

Reply AI and approval workflow

审计日志

Channel audit trail

GET/api/audit-logs

Get channel audit logs

Channel audit trail

数据质量

Quality issues and fixes

GET/api/quality/issues

Get quality issues

Quality issues and fixes

POST/api/quality/issues/{id}/fix

Fix quality issue

Quality issues and fixes

训练中心

Training models and jobs

GET/api/ai-training/jobs

Get training jobs

Training models and jobs

GET/api/ai-training/models

Get training models

Training models and jobs

POST/api/ai-training/models/{id}/pause

Pause model

Training models and jobs

POST/api/ai-training/models/{id}/retrain

Retrain model

Training models and jobs

POST/api/ai-training/models/{id}/start

Start model

Training models and jobs

任务调度

Scheduler jobs and runs

GET/api/scheduler/health

Get scheduler health

Scheduler jobs and runs

GET/api/scheduler/jobs

Get scheduler jobs

Scheduler jobs and runs

POST/api/scheduler/jobs

Create scheduler job

Scheduler jobs and runs

PATCH/api/scheduler/jobs/{id}

Update scheduler job

Scheduler jobs and runs

DELETE/api/scheduler/jobs/{id}

Delete scheduler job

Scheduler jobs and runs

POST/api/scheduler/jobs/{id}/pause

Pause scheduler job

Scheduler jobs and runs

POST/api/scheduler/jobs/{id}/resume

Resume scheduler job

Scheduler jobs and runs

POST/api/scheduler/jobs/{id}/run

Run scheduler job

Scheduler jobs and runs

GET/api/scheduler/runs

Get scheduler runs

Scheduler jobs and runs

高级搜索

Search queries and saved searches

GET/api/search/health

Get search health

Search queries and saved searches

GET/api/search/history

Get search history

Search queries and saved searches

GET/api/search/query

Run search query (GET)

Search queries and saved searches

POST/api/search/query

Run search query and persist history

Search queries and saved searches

GET/api/search/saved

Get saved searches

Search queries and saved searches

POST/api/search/saved

Save search

Search queries and saved searches

DELETE/api/search/saved/{id}

Delete saved search

Search queries and saved searches

实时通信

Channels and events

GET/api/realtime/channels

Get realtime channels

Channels and events

POST/api/realtime/connect

Connect channel

Channels and events

POST/api/realtime/disconnect

Disconnect channel

Channels and events

GET/api/realtime/events

Get realtime events

Channels and events

GET/api/realtime/health

Get realtime health

Channels and events

POST/api/realtime/test

Send realtime test event

Channels and events

数据大屏

Metrics and charts

GET/api/databoard/charts

Get databoard charts

Metrics and charts

GET/api/databoard/health

Get databoard health

Metrics and charts

GET/api/databoard/metrics

Get databoard metrics

Metrics and charts

智能洞察

Insight generation and history

POST/api/ai-insights/generate

Generate AI insight

Insight generation and history

GET/api/ai-insights/health

Get AI insight health

Insight generation and history

GET/api/ai-insights/history

Get AI insight history

Insight generation and history

GET/api/ai-insights/summary

Get latest AI insight summary

Insight generation and history

合规

Compliance cases and logs

GET/api/compliance/audit-logs

Get compliance audit logs

Compliance cases and logs

GET/api/compliance/cases

Get compliance cases

Compliance cases and logs

POST/api/compliance/cases

Create compliance case

Compliance cases and logs

GET/api/compliance/health

Get compliance health

Compliance cases and logs

权限

Roles

GET/api/permissions/audit-logs

Get permission audit logs

Roles

GET/api/permissions/grants

Get permission grants

Roles

POST/api/permissions/grants

Create permission grant

Roles

DELETE/api/permissions/grants/{id}

Delete permission grant

Roles

GET/api/permissions/health

Get permissions health

Roles

GET/api/permissions/roles

Get roles

Roles

GET/api/permissions/users

Get users

Roles

国际化

Locales and translations

GET/api/i18n/health

Get i18n health

Locales and translations

GET/api/i18n/locales

Get locales

Locales and translations

POST/api/i18n/locales/{locale}/publish

Publish locale

Locales and translations

GET/api/i18n/publish-logs

Get publish logs

Locales and translations

GET/api/i18n/translations

Get translations

Locales and translations

主题

Theme settings

GET/api/themes/current

Get current theme

Theme settings

POST/api/themes/current

Update current theme

Theme settings

GET/api/themes/health

Get themes health

Theme settings

GET/api/themes/logs

Get theme logs

Theme settings

移动端

Devices

GET/api/mobile/devices

Get mobile devices

Devices

GET/api/mobile/health

Get mobile health

Devices

GET/api/mobile/push/logs

Get mobile push logs

Devices

POST/api/mobile/push/test

Send mobile push test

Devices

GET/api/mobile/releases

Get mobile releases

Devices

快捷键

Shortcut configuration

GET/api/shortcuts

Get shortcuts

Shortcut configuration

POST/api/shortcuts

Create shortcut

Shortcut configuration

DELETE/api/shortcuts/{id}

Delete shortcut

Shortcut configuration

GET/api/shortcuts/health

Get shortcuts health

Shortcut configuration

新手引导

Onboarding tasks

GET/api/onboarding/health

Get onboarding health

Onboarding tasks

GET/api/onboarding/tasks

Get onboarding tasks

Onboarding tasks

POST/api/onboarding/tasks/{id}/complete

Complete onboarding task

Onboarding tasks

用户反馈

Feedback items and votes

GET/api/feedback/health

Get feedback health

Feedback items and votes

GET/api/feedback/items

Get feedback items

Feedback items and votes

POST/api/feedback/items

Create feedback item

Feedback items and votes

POST/api/feedback/items/{id}/vote

Vote feedback item

Feedback items and votes

回调管理

Managed webhooks and logs

GET/api/webhooks

Get managed webhooks

Managed webhooks and logs

POST/api/webhooks

Create webhook

Managed webhooks and logs

DELETE/api/webhooks/{id}

Delete webhook

Managed webhooks and logs

GET/api/webhooks/logs

Get webhook logs

Managed webhooks and logs

POST/api/webhooks/test

Send webhook test request

Managed webhooks and logs

元信息

Version and capability APIs

GET/api/capabilities

Get capability registry

Version and capability APIs

GET/api/version

Get version and runtime capabilities

Version and capability APIs