使用文档

欢迎使用 TimelyNotify（及时通知）。本页面是使用文档首页，从这里可以跳转到各个章节。

章节导航

• API 文档 —— 接口地址、认证方式、请求参数与返回示例
• 服务端自部署 —— 在自己的服务器上部署 TimelyNotify
• 常见问答 —— 使用过程中的高频问题与解答

快速上手

1. 获取 API Key
2. 调用发送接口，传入渠道、接收人与模板参数
3. 通过消息 ID 查询送达状态

import TimelyNotify from "timelynotify";

const client = new TimelyNotify({
  apiKey: "your-api-key",
});

await client.send({
  channel: "email",
  to: "user@example.com",
  template: "welcome",
  params: { name: "张三" },
});

更多细节见 API 文档。