强大、易用、高效的消息推送开放平台
# API基础地址
https://waterfallapi.zhaoyizhe.com/waterfall/wapi/
# 认证方式
所有API请求都需要提供 accessSecret 参数进行身份认证。
# 请求格式
- 支持方式: GET / POST
- 编码格式: UTF-8
- 数据格式: JSON (推荐) / URL参数
# 📋 API接口总览
| 接口类别 | 接口名称 | 功能描述 | 请求方式 |
|---|---|---|---|
| 📄 模板管理 | 获取模板列表 | 获取系统模板和自定义模板列表 | GET |
| 👥 用户管理 | 获取用户列表 | 获取应用下的用户列表，支持关键词搜索 | GET |
| 📨 消息推送 | 发送消息 | 核心功能，支持立即/定时发送，全部/指定用户 | GET/POST |
| ⚠️ 错误处理 | 错误码说明 | 完整的错误码列表和处理建议 | - |
# 🔧 核心功能
# 💬 消息推送
- 多种发送方式: 立即发送、定时发送
- 灵活的目标选择: 全部用户、指定用户
- 富文本支持: HTML格式的消息详情页面
- 模板变量: 动态内容替换，个性化推送
# 📱 模板管理
- 系统模板: 平台提供的通用消息模板
- 自定义模板: 用户创建的个性化模板
- 变量定义: 灵活的模板变量系统
# 👤 用户管理
- 用户列表: 获取应用下的所有用户
- 搜索功能: 支持关键词模糊搜索
- 用户属性: 详细的用户信息和状态
# 🌟 特色优势
🚀 高性能
- 每秒支持1000+并发请求
- 毫秒级响应时间
- 99.9%服务可用性
🔒 安全可靠
- 访问密钥认证机制
- 数据传输加密保护
- 完善的错误处理机制
🎯 易于集成
- RESTful API设计
- 支持多种编程语言
- 详细的示例代码
# 详细步骤：
- 🔑 获取认证: 从管理后台获取应用的
accessSecret - 📋 选择模板: 调用获取模板列表接口，选择合适的消息模板
- 👥 确定用户: 获取用户列表，确定推送目标
- ✏️ 构造内容: 根据模板定义，准备模板变量数据
- 📤 发送消息: 调用发送消息接口，执行推送
- ✅ 处理结果: 根据返回结果进行相应处理
# 🎯 使用场景
# 📢 营销推广
- 产品促销通知
- 活动邀请消息
- 会员福利推送
# 📋 业务通知
- 订单状态更新
- 物流配送通知
- 账户安全提醒
# 📅 定时提醒
- 生日祝福消息
- 会议提醒通知
- 到期提醒服务
# ⚠️ 重要提醒
使用限制
- 请求频率: 每秒最多1000次API调用
- 消息大小: 单条消息内容不超过10KB
- 批量限制: 单次最多推送给100个用户
- 时间限制: 定时发送至少提前5分钟设置
最佳实践
- 推荐使用POST方式发送消息
- 建议实现完善的错误处理机制
- 定期检查应用和模板的审核状态
- 合理控制推送频率，避免打扰用户
# 📞 技术支持
📧 邮件支持
zhangxiao@zhaoyizhe.com
技术问题咨询
💬 微信公众号
瀑布消息
产品动态和更新
⏰ 服务时间
工作日 9:00-18:00
快速响应支持