API 概览

基础 URL

沙盒(当前公共主机):

https://api.morisbox.com/api/v1

除非另有说明,所有端点都位于 /api/v1 下。

环境基础 URL
沙盒https://api.morisbox.com/api/v1
本地 Dockerhttp://127.0.0.1:11300/api/v1
沙盒服务URL
合作伙伴中心https://partner.morisbox.com
合作伙伴文档https://docs.morisbox.com/partners
开发者文档https://developers.morisbox.com/developers
开发者控制台https://developers.morisbox.com/login
客户端应用https://morisbox.com

约定

主题规则
格式JSON 请求 / JSON 响应
身份验证Authorization: Bearer <api_key>
手机号码E.164(+228XXXXXXXX
日期ISO-8601 字符串
错误{ "error": { "code", "message" } }
创建成功通常为 201

两个 API 界面

界面密钥受众文档
合作伙伴 APIsk_…合作伙伴组织本站(消息、机器人等)
开发者 APIsk_dev_…独立开发者docs.morisbox.com/developers

资源分组(合作伙伴)

分组前缀文档
消息/messages消息
投递证明/messages/{id}/audit安全与合规
广播/broadcasts广播
模板/templates模板
账户/accounts账户与关联
对话/conversations对话
机器人/bots机器人
验证/validate/*字段验证
设置/settings/*密钥、用户、字段和合规

资源分组(开发者)

分组前缀文档
身份验证/auth/developer/*开发者文档
个人资料 / 设置/dev/me/dev/settings开发者文档
密钥/dev/api-keys开发者文档
MorisBox 模板/dev/templates开发者文档
消息/dev/messages开发者文档

合作伙伴示例:列出消息

GET /api/v1/messages?phone=%2B228XXXXXXXX&limit=20
Authorization: Bearer sk_…

开发者示例:使用模板发送

POST /api/v1/dev/messages
Authorization: Bearer sk_dev_…
Content-Type: application/json

{
  "phone": "+228XXXXXXXX",
  "template_code": "notification",
  "lang": "fr",
  "vars": { "text": "Bonjour" }
}

速率限制

系统可能按密钥实施速率限制。触发限制时,API 返回 429 和重试提示。高容量投递时,合作伙伴应优先使用广播

版本控制

当前公共版本为 v1。破坏性变更将使用新前缀(/api/v2),或提供有文档说明的弃用窗口。