接入说明

当前 iOS 正在准备内测。请向本站管理员获取 App 安装入口、业务 API Key 与模板 ID;本站不提供公开注册。已获得资料的接入人员,可按以下流程操作。

接入前准备

  1. 业务系统具备服务端修改或订单回调能力。
  2. 管理员在后台创建来源与模板,保存 API Key 和模板 ID。
  3. 在 App 联网注册,复制六位接收码,保留前导零。

发送一条模板消息

管理员创建接入来源和消息模板。在业务系统服务端保存 API Key、模板 ID 与手机的六位接收码;下单成功后提交 JSON 到 index.php?route=api/v1/messages,请求头使用 Authorization: Bearer API_KEY。

{"template_id":"模板ID","token":"083619",
 "event_id":"order_001","fields":{}}

字段按后台模板定义提交,示例中的空对象需要替换成该模板所需字段。不要在网页或小程序前端保存发送密钥。

成功与失败

首次成功返回 HTTP 202,JSON 为 {"success":true,"data":{"message_id":"msg_…","status":"queued","duplicate":false},"error":null}。成功仅表示消息已保存并入队;不代表手机已经显示。

相同来源、接收实例与 event_id 的一致重试返回原消息 ID;同事件内容不同返回 409。401 表示凭证无效,403 表示模板授权失败,404 表示接收码或模板不可用,422 表示字段错误,429 表示超限,503 表示服务暂不可用。

查询发送状态

使用相同 API Key 请求 GET index.php?route=api/v1/messages/消息ID,只能查询本来源发送的消息。accepted 为通道已受理,read_at 为打开消息时间;两者都不表示订单已处理。

业务侧处理

每次业务事件重试保持相同 event_id。通知失败不回滚订单。多手机分别发送。