用戶Token

用戶token

訊息Token

訊息令牌

訊息令牌和用戶token均可用於發送訊息

我的好友
試一試

試一試

查看發送訊息限制和解封帳戶方法。

未實名認證的使用者無法呼叫發送訊息介面。

傳送結果查詢

發送結果查詢

呼叫方式

呼叫方式

更多使用方式請查看訊息介面文件和線上測試介面

HTTP 介面

請求位址：https://www.pushplus.plus/send，參數透過 URL query 傳遞

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

請求位址：https://www.pushplus.plus/send，參數透過 JSON body 傳遞，Content-Type: application/json

curl -X POST "https://www.pushplus.plus/send" \
  -H "Content-Type: application/json" \
  -d '{
    "token": "${_token_}",
    "title": "XXX",
    "content": "XXX",
    "template": "html",
    "to": "XXX"
  }'

請求位址：https://www.pushplus.plus/send，參數透過 JSON body 傳遞，Content-Type: application/json

curl -X PUT "https://www.pushplus.plus/send" \
  -H "Content-Type: application/json" \
  -d '{
    "token": "${_token_}",
    "title": "XXX",
    "content": "XXX",
    "template": "html",
    "to": "XXX"
  }'

請求位址：https://www.pushplus.plus/send，參數透過 URL query 傳遞

curl -X DELETE "https://www.pushplus.plus/send?token=${_token_}&title=XXX&content=XXX&template=html&to=XXX"
請求參數

參數名稱

是否必填

預設值

描述

token是無用戶令牌或訊息令牌。GET/DELETE 請求也可直接加在請求位址後，如：https://www.pushplus.plus/send/{token}?content=XXX
title否無訊息標題
content是無具體訊息內容，依不同 template 支援不同格式。訊息內容較長時請使用 POST/PUT 請求
template否html傳送訊息範本
to否無微信服務號渠道填寫好友令牌，企業微信渠道填寫企業微信用戶 id。多人以逗號分隔
channel否wechat傳送渠道
option否無渠道設定參數(原 webhook 參數)
callbackUrl否無回呼位址，非同步回呼傳送結果
timestamp否無時間戳記，毫秒。若小於目前時間，訊息將無法傳送
pre否無預處理資訊編碼。僅供會員使用。需先在個人中心新增預處理程式碼。
pushId否無推送表單/文件/表格。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；支援 Android、鴻蒙和 iOS 系統APP渠道使用說明
extension免費擴充功能；支援瀏覽器擴充功能和桌面應用程式瀏覽器擴充功能渠道設定
桌面應用程式使用教學
webhook免費第三方 webhook 服務；企業微信機器人、釘釘機器人、飛書機器人webhook渠道設定
clawbot免費微信ClawBotclawbot渠道使用說明
cmcc免費新消息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伺服器端驗證錯誤（詳見回傳內容）