平台
MorisBox 通过一个合作伙伴 API,覆盖多个客户端界面和投递渠道。本页列出当前提供的全部功能。
核心概览
| 层级 | 说明 | 使用方 |
|---|
| 合作伙伴 API | 用于消息、账户、模板、机器人和 Webhook 的 REST API(/api/v1) | 您的后端 |
| 合作伙伴中心 | 管理密钥、机器人、模板和支持回复的 Web 控制台 | 合作伙伴运营人员 |
| 合作伙伴文档 | 本站:API 参考和集成指南 | 开发者 |
| 移动应用 | 面向最终用户的原生 iOS / Android 应用(Expo) | 最终用户 |
| 客户端应用 | 渐进式 Web 应用(与移动端属于同一产品) | 最终用户 |
| 实时服务 | 收件箱、聊天和广播的实时推送 | 移动端 / 客户端应用 |
| 应用内渠道 | 在 MorisBox 移动端 / 客户端应用内投递 | 主要路径 |
| WhatsApp 渠道 | 应用内不可用时的备用投递 / 触达 | 备用 |
| SMS 渠道 | OTP 和关键提醒的最终备用渠道 | 备用 |
只需调用一次发送接口,MorisBox 会按顺序选择最佳渠道。
投递渠道
每个合作伙伴可配置一条有序渠道链,单条消息也可以覆盖它。典型生产顺序如下:
| 顺序 | 渠道代码 | 界面 | 典型用途 |
|---|
| 1 | inapp | MorisBox 移动端和客户端应用 | 中心消息、流程、新闻简报和聊天,体验最丰富 |
| 2 | whatsapp | WhatsApp | 用户离线 / 未安装应用;兼容模板的提醒 |
| 3 | sms | SMS | OTP、未认领账户和最终备用文本 |
行为说明
| 主题 | 规则 |
|---|
| 已认领账户 | 用户认领 MorisBox 后优先使用 inapp |
| 未认领账户 | 通常跳过应用内渠道(not_claimed)→ WhatsApp / SMS |
| OTP | 尚无应用会话时可强制使用 SMS / WhatsApp |
| 超时 | 按步骤配置;失败或超时后 → 下一个渠道 |
| 离线提醒 | 应用内投递后,如果用户离线 → 通过 WhatsApp/SMS 发送“MorisBox 中有新消息”的提醒,但不包含 E2EE 正文 |
| 幂等性 | 相同 idempotency_key 不会触发重复扇出 |
有关账户生命周期,请参阅核心概念;有关发送有效载荷,请参阅消息。
最终用户平台
用户使用手机号码和 OTP 进行身份验证。已关联的合作伙伴会显示在其中心中。
移动端(iOS / Android)
| |
|---|
| 产品 | 原生 MorisBox 应用(Expo) |
| 身份验证 | 无密码 OTP |
| 功能 | 合作伙伴中心、独立消息、媒体、HTML 新闻简报、链接 CTA、交互式流程、机器人、支持对话、置顶 / 未读和实时更新 |
| 最适合 | 支持完整离线体验、可推送的客户端和生产环境用户 |
客户端应用(Web)
| |
|---|
| 产品 | 与移动端相同的最终用户产品,以渐进式 Web 应用提供 |
| 身份验证 | 无密码 OTP |
| 功能 | 与移动端相同的中心模型:消息、流程、机器人、支持和新闻简报 |
| 最适合 | 无需从应用商店安装即可立即访问;合作伙伴演示和桌面用户 |
用户看到的内容(中心模型)
| 区域 | 用途 |
|---|
| 消息 | 独立的合作伙伴内容(文本、媒体、链接、HTML 和流程卡片),不是聊天会话 |
| 表单 / 机器人 | 交互式多步骤流程和机器人菜单 |
| 对话 | 由用户发起的支持会话 |
合作伙伴 API 的 POST /messages 始终以中心为目标,而不是支持聊天。详情请参阅:消息 UI 与体验。
合作伙伴平台
合作伙伴 API
| |
|---|
| 基础地址 | https://api.morisbox.com/api/v1(沙盒) |
| 身份验证 | Authorization: Bearer <api_key> |
| 功能 | 发送所有内容类型、账户与关联、模板、广播、客服对话、机器人、Webhook 和沙盒 |
完整目录:API 概览 · 快速入门 · 身份验证。
合作伙伴中心
开发者控制台
合作伙伴文档
| |
|---|
| 产品 | 合作伙伴文档(docs.morisbox.com/partners)和开发者文档(docs.morisbox.com/developers) |
| 受众 | 合作伙伴和开发者集成工程师 |
| 范围 | REST、媒体类型、新闻简报、流程、机器人、Webhook、开发者和沙盒 |
实时平台
为最终用户客户端提供实时更新:新的中心消息、对话事件和广播投递。
| |
|---|
| 传输方式 | 通过实时边缘服务使用 Socket.IO |
| 客户端 | 具有已验证用户会话的移动端和客户端应用 |
| 扩展模型 | 无状态网关;按用户账户划分房间 |
| 对合作伙伴的影响 | 您只需通过 REST 发送一次;客户端无需轮询即可实时更新 |
合作伙伴后端无需为常规发送调用实时层,合作伙伴 API 已足够。
各平台的内容类型
content_type | 应用内(移动端 / 客户端应用) | WhatsApp | SMS |
|---|
text | 完整显示 | 是(文本) | 是(可能截断) |
image | 完整查看器 | 取决于提供方 | 链接 / 跳过 |
document | 下载 / 打开 | 取决于提供方 | 链接 / 跳过 |
audio | 播放器 | 取决于提供方 | 链接 / 跳过 |
video | 播放器 | 取决于提供方 | 链接 / 跳过 |
link | CTA 卡片 | 文本和 URL | URL |
html | 完整 HTML 新闻简报阅读器 | 摘要 / 链接 | 摘要 / 链接 |
flow | 交互式多步骤 UI | 邀请文本和深度链接 | 邀请文本 |
system | 平台通知 | 很少使用 | 很少使用 |
应用内始终提供最丰富的体验。设计有效载荷时应优先考虑应用内,并为最后一公里备用投递保留兼容 SMS 的简短文本。
交互式平台(流程和机器人)
平台矩阵(通信关系)
Your systems
│ Partner API key
▼
Partner API ──────► routing (inapp → whatsapp → sms)
│ │
│ ├─► Mobile / Client Application (hub + realtime)
│ ├─► WhatsApp
│ └─► SMS
│
├─► Partner Hub (operators)
└─► Webhooks → your HTTPS endpoints
可用性摘要
| 平台 | 状态 | 说明 |
|---|
| 合作伙伴 REST API | 可用 | 生产集成路径 |
| 合作伙伴中心 | 可用 | 运营和配置 |
| 合作伙伴文档 | 可用 | 本站 |
| 移动应用 | 可用 | 通过 Expo 提供 iOS / Android 版本 |
| 客户端应用 | 可用 | 与移动端属于同一产品系列 |
| 实时推送 | 可用 | 实时收件箱、聊天和广播 |
inapp 渠道 | 可用 | 主要投递渠道 |
whatsapp 渠道 | 可用 | 按部署配置适配器 / 提供方 |
sms 渠道 | 可用 | 按部署配置适配器 / 提供方 |
| 沙盒密钥 | 可用 | 无风险发送测试,请参阅沙盒 |
| 应用内 E2EE | 可用 | 对话和加密中心有效载荷,请参阅 E2EE 加密 |
| 电子邮箱 / 原生推送渠道 | 路线图 | 尚未加入默认渠道链 |
WhatsApp 和 SMS 的提供方连接取决于环境(正式密钥或本地模拟服务)。每个环境中的备用渠道链行为一致。
选择合适的界面
| 目标 | 使用方式 |
|---|
| 发送 OTP / 关键提醒 | 合作伙伴 API → 根据需要优先使用 SMS/WA 的渠道链 |
| 丰富的新闻简报或媒体 | content_type=html / image / video → 优先应用内 |
| 多步骤表单(SEED 风格) | 流程邀请和流程运行器 |
| 持续支持 | 用户发起对话;客服人员通过中心 / API 回复 |
| 群发公告 | 广播 API |
| 自动化菜单 | 360Bots(本地或服务运行时) |
后续步骤