# 发送消息
发送消息是瀑布消息平台的核心功能。本文档详细介绍如何通过API发送消息。
# 📋 API概览
# 基础信息
- 接口地址:
POST/GET https://waterfallapi.zhaoyizhe.com/waterfall/wapi/send - 认证方式: 请参考参数说明
- 请求格式: JSON
- 响应格式: JSON
- 该接口推荐POST请求
# 请求头设置
Content-Type: application/json
# 📝 请求参数
# 参数说明
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
accessSecret | string | 发送消息密钥 | 5dae3031043e4.....60754 |
pushIds | string | 目标用户ID,pushRange字段为1时可不填 | aaa,bbb,ccc |
templateId | string | 模板ID | 4d5e6f7g8h9i0j1k2l3m4n5o6p7q8r9s |
pushTime | string | 推送时间,pushTimeType为1时可不填 | 2025-07-05 12:30:22 |
affiliatedJson | string | 推送内容 | 详见下方参数说明 |
pushRange | int | 发送范围 1全部用户 2指定用户 | 1 |
pushTimeType | int | 1:立即发送,2:定时发送 | 1 |
messageInfo | string | 消息详情(html格式) | 详见下方参数说明 |
# 参数说明
affiliatedJson
推送内容,与消息模板key值一一对应,以物流通知为例,传参时请传JSON字符串;如果是GET请求,该字段务必进行urlEncode(URL编码)
例如消息模板定义为:
[{"label":"物流状态","type":"text","key":"${title}"},{"label":"快递单号","type":"text","key":"${field_2}"},{"label":"预计送达","type":"text","key":"${field_3}"}]
- POST请求传参示例:
[ { "key": "${title}", "value": "待签收" }, { "key": "${field_2}", "value": "SF3284920349" }, { "key": "${field_3}", "value": "2025-09-11 12:21" } ]
- GET请求传参示例:
%5B%20%7B%20%22key%22%3A%20%22%24%7Btitle%7D%22%2C%20%22value%22%3A%20%22%E5%BE%85%E7%AD%BE%E6%94%B6%22%20%7D%2C%20%7B%20%22key%22%3A%20%22%24%7Bfield_2%7D%22%2C%20%22value%22%3A%20%22SF3284920349%22%20%7D%2C%20%7B%20%22key%22%3A%20%22%24%7Bfield_3%7D%22%2C%20%22value%22%3A%20%222025-09-11%2012%3A21%22%20%7D%20%5D
messageInfo 消息详情,html编码字符串,填写该值后,推送消息将会显示[查看详情]按钮,点击后可进入详情界面
- 传参示例:
<p>这是消息详情</p>
# ❗ 注意事项
重要提醒
- 频率限制: 每秒最多1000次API调用
- 内容限制: 单条消息内容不超过10KB
- 用户限制: 批量发送单次最多100个用户
- 发送时间: 如选择定时发送,定时发送时间不得小于当前时间+5分钟
# 📞 技术支持
如果在发送消息过程中遇到问题:
- 📧 邮箱: zhangxiao@zhaoyizhe.com
- 💬 公众号: 瀑布消息
恭喜!您已经掌握了发送消息的核心功能。接下来可以探索: