用途:面向 Front REST API 的集成开发与调试参考,帮助确认接口模式、可空字段、枚举取值及端点路径,并辅助排查 Front SDK 相关问题。
主要能力:提供完整 OpenAPI 规范文件 core-api.json(13k+ 行)作为唯一事实来源,覆盖请求/响应模式、可空字段、枚举值和端点路径。重点整理了 Message、Conversation、Recipient 等关键模式:Message 的 recipients[].name 可空、recipients[]._links.related.contact 可空、recipients[].role 枚举为 from/to/cc/bcc/reply-to、author 可空(外部入站为 null)、text 可空(正文纯文本版本);Conversation 的 assignee 可空、某些会话类型下 recipient 可空、tags 可为空数组、last_message 可空、scheduled_reminders 可空;Recipient 结构包含 name(string|null)、handle(string,必填)、role、_links.related.contact(string|null)。
常见注意点:webhooks 只发送预览,须再通过 API 获取完整数据;许多字段可空,不应假定存在,Zod 中应使用 .nullable();_links.related.contact 在收件人无联系记录时为 null;role 枚举包含 reply-to,容易被遗漏。
SDK 位置:@skillrecordings/front-sdk,其 Zod 模式应与该规范完全一致。
常用端点:GET /messages/{id}(含正文的完整消息)、GET /conversations/{id}(会话详情)、GET /conversations/{id}/messages(消息历史)、POST /conversations/{id}/drafts(创建草稿回复)、GET /inboxes/{id}(收件箱详情)。
适用场景:对接 Front 邮箱/会话数据的后端服务开发、SDK 模式校验、webhook 处理后补全数据、排查字段缺失或类型不匹配问题。
限制:资料未提供认证方式、速率限制、具体请求示例、错误码及价格信息,暂未提供。