用户Token

用户token

消息Token

消息token

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

试一试

试一试

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

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

发送结果查询

发送结果查询

调用方式

调用方式

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

HTTP GET和DELETE请求

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

参数名称

是否必须

参数类型

默认值

描述

token是query无用户令牌或消息令牌，可直接加到请求地址后，如：https://www.pushplus.plus/send/{token}?content=XXX
title否query无消息标题
content是query无具体消息内容，根据不同template支持不同格式。太长的消息内容用post请求，不要用get请求！
template否queryhtml发送消息模板
channel否querywechat发送渠道
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否bodyhtml发送消息模板
channel否bodywechat发送渠道
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阿里云监控报警定制模板阿里云监控
jenkinsjenkins插件定制模板jenkins插件
route路由器插件定制模板路由器插件
pay支付成功通知模板支付成功模板教程
formpush表单模板push表单
docpush文档模板push文档
excelpush表格模板push表格
发送渠道枚举

发送渠道枚举

channel发送渠道枚举

发送渠道

是否免费

描述

使用教程

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

返回码说明

接口返回码说明

返回码

说明

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