用户Token

用户token

消息Token

消息token

消息token和用户token均可用于发送消息

我的好友
试一试

试一试

查看发送消息限制和解封账号方法。

未实名认证用户无法调用发送消息接口。

发送结果查询

发送结果查询

调用方式

调用方式

更多使用方式查看消息接口文档和在线测试接口

HTTP GET和DELETE请求

https://www.pushplus.plus/send?token=${_token_}&title=XXX&content=XXX&template=html&to=XXX

参数名称

是否必须

参数类型

默认值

描述
token 是 query 无 用户令牌或消息令牌，可直接加到请求地址后，如：https://www.pushplus.plus/send/{token}?content=XXX
title 否 query 无 消息标题
content 是 query 无 具体消息内容，根据不同template支持不同格式。太长的消息内容用post请求，不要用get请求！
template 否 query html 发送消息模板
to 否 query 无 微信服务号渠道填写好友令牌，企业微信渠道填写企业微信用户id。多人用逗号隔开
channel 否 query wechat 发送渠道
option 否 query 无 渠道配置参数(原webhook参数)
callbackUrl 否 query 无 回调地址，异步回调发送结果
timestamp 否 query 无 时间戳，毫秒。如小于当前时间，消息将无法发送
pre 否 query 无 预处理信息编码。仅供会员使用。需要先在个人中心中添加预处理代码。
pushId 否 query 无 推送表单/文档/表格。template=form 时必填，传表单编码（formCode）；template=doc 时必填，传文档编码（docCode）；template=excel 时必填，传表格编码（docCode）

HTTP POST和PUT请求

https://www.pushplus.plus/send

Content-Type: application/json

参数名称

是否必须

参数类型

默认值

描述
token 是 body 无 用户令牌或消息令牌
title 否 body 无 消息标题
content 是 body 无 具体消息内容，根据不同template支持不同格式
template 否 body html 发送消息模板
to 否 body 无 微信服务号渠道填写好友令牌，企业微信渠道填写企业微信用户id。多人用逗号隔开
channel 否 body wechat 发送渠道
option 否 body 无 渠道配置参数(原webhook参数)
callbackUrl 否 body 无 回调地址，异步回调发送结果
timestamp 否 body 无 时间戳，毫秒。如小于当前时间，消息将无法发送
pre 否 body 无 预处理信息编码。仅供会员使用。需要先在个人中心中添加预处理代码。
pushId 否 body 无 推送表单/文档/表格。template=form 时必填，传表单编码（formCode）；template=doc 时必填，传文档编码（docCode）；template=excel 时必填，传表格编码（docCode）

邮件推送

向专属邮箱 ${_token_}@yp9.cn 发送邮件，即可触发 pushplus 消息推送。邮件主题作为消息标题，邮件正文作为消息内容。一对多/好友消息通过抄送地址指定。

参数说明

说明
收件人 token@yp9.cn，其中 token 为用户令牌或消息令牌
一对一消息 仅填写收件人，不填写抄送，推送给自己
一对多消息 抄送填写 群组编码@yp9.cn，支持多个
好友消息 抄送填写 好友令牌@yp9.cn，支持多个
邮件主题 对应推送消息的 title
邮件正文 对应推送消息的 content
发送渠道 使用该令牌对应的默认发送渠道；消息令牌按其自身渠道配置发送
模板枚举

模板枚举

template消息模板枚举

模板名称

描述

使用教程
html 支持html文本。为空默认使用html模板
txt 纯文本内容,不转义html内容,换行使用\n
json 可视化展示json格式内容
markdown 内容基于markdown格式展示
cloudMonitor 阿里云监控报警定制模板 阿里云监控
jenkins jenkins插件定制模板 jenkins插件
route 路由器插件定制模板 路由器插件
pay 支付成功通知模板 支付成功模板教程
form push表单模板 push表单
doc push文档模板 push文档
excel push表格模板 push表格
发送渠道枚举

发送渠道枚举

channel发送渠道枚举

发送渠道

是否免费

描述

使用教程
wechat 免费 微信服务号,默认发送渠道
app 免费 App；支持安卓、鸿蒙和iOS系统 APP渠道使用说明
extension 免费 插件；支持浏览器扩展插件和桌面应用程序 浏览器插件渠道配置
桌面应用程序使用教程
webhook 免费 第三方webhook服务；企业微信机器人、钉钉机器人、飞书机器人 webhook渠道配置
clawbot 免费 微信ClawBot clawbot渠道使用说明
qq 免费 QQ机器人，不传option发给自己，option传渠道配置编码可指定QQ群 qq渠道使用说明
cp 免费 企业微信应用 企业微信应用配置
mail 免费 邮件 邮件渠道使用说明
sms 收费 短信；收费使用，1条短信扣减10积分 短信渠道配置
voice 收费 语音；收费使用，1条语音呼叫扣减30积分 语音渠道配置
返回码说明

返回码说明

接口返回码说明

返回码

说明
200 执行成功
302 未登录
401 请求未授权(排除开放接口功能是否启用)
403 请求IP未授权(开放接口中排除是否将请求IP加入到白名单中)
500 系统异常，请稍后再试
600 数据异常，操作失败
805 无权查看
888 积分不足，需要充值
900 用户账号使用受限(请求次数过多，停止继续请求)
905 账户未进行实名认证(实名认证后即可发送消息)
903 无效的用户令牌(发送消息使用的token不正确)
999 服务端验证错误（具体查看返回内容）