User Token

User Token

Message Token

Message Token

Both Message Tokens and the User Token can be used to send messages

Group Management
Try It

Try It

See the sending limits and how to unblock your account.

Users without Real-name Verification cannot call the send API.

Delivery Result Query

Check Send Result

How to Call

How to Call

For more options, see the Message API docs and the online API tester

HTTP API

Endpoint: https://www.pushplus.plus/send. Parameters are passed in the URL query string

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

Endpoint: https://www.pushplus.plus/send. Parameters are passed in a 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",
    "topic": "XXX"
  }'

Endpoint: https://www.pushplus.plus/send. Parameters are passed in a 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",
    "topic": "XXX"
  }'

Endpoint: https://www.pushplus.plus/send. Parameters are passed in the URL query string

curl -X DELETE "https://www.pushplus.plus/send?token=${_token_}&title=XXX&content=XXX&template=html&topic=XXX"
Request Parameters

Parameter

Required

Default

Description

tokenYesNoneUser token or Message Token. For GET/DELETE requests it can also be appended to the URL, e.g. https://www.pushplus.plus/send/{token}?content=XXX
titleNoNoneMessage title
contentYesNoneMessage body. Supported formats depend on the template. Use POST/PUT for long content
templateNohtmlMessage template
topicNoNoneGroup code
channelNowechatDelivery channel
optionNoNoneChannel configuration parameter (formerly the webhook parameter)
callbackUrlNoNoneCallback URL that receives the delivery result asynchronously
timestampNoNoneTimestamp in milliseconds. Messages with a timestamp earlier than the current time will not be sent
preNoNonePreprocessing code. Members only. You need to add Preprocessing code in your account center first.
pushIdNoNonepush Form/Doc/Sheet. Required when template=form (pass the form code, formCode), template=doc (pass the doc code, docCode) or template=excel (pass the sheet code, docCode)

Push via Email

Send an email to your dedicated address ${_token_}@yp9.cn to trigger a pushplus message. The email subject becomes the message title and the email body becomes the message content. Specify One-to-Many or Friend Message recipients via CC.

Field

Description

Totoken@yp9.cn, where token is your user token or a Message Token
One-to-One MessageFill in only the recipient with no CC to push to yourself
One-to-Many MessageAdd GroupCode@yp9.cn to CC; multiple addresses supported
Friend MessageAdd FriendToken@yp9.cn to CC; multiple addresses supported
SubjectMaps to the message title
BodyMaps to the message content
ChannelUses the token's default delivery channel; a Message Token sends through its own channel configuration
Template Types

Template Values

template values

Template

Description

Guide

htmlHTML content. Used by default when empty
txtPlain text; HTML is not escaped, use \n for line breaks
jsonRenders JSON content in a readable view
markdownRenders content as Markdown
cloudMonitorCustom template for Alibaba Cloud Monitor alertsAlibaba Cloud Monitor
jenkinsCustom template for the Jenkins pluginJenkins plugin
routeCustom template for router pluginsRouter plugin
payPayment success notification templatePayment template guide
formpush Form templatepush Form
docpush Doc templatepush Doc
excelpush Sheet templatepush Sheet
Channel Types

Channel Values

channel values

Channel

Free

Description

Guide

wechatFreeWeChat Official Account, the default channel
appFreeApp; supports Android, HarmonyOS and iOSApp channel guide
extensionFreeExtension; supports browser extensions and the desktop appBrowser extension channel setup
Desktop app guide
webhookFreeThird-party webhook services: WeCom bots, DingTalk bots, Feishu botsWebhook channel setup
clawbotFreeWeChat ClawBotClawBot channel guide
cmccFreeNew Message ClawBot, China Mobile users only, delivered as SMSNew Message ClawBot channel guide
qqFreeQQ bot, supports both the official bot and your own bots. Without option, the message goes to yourself via the default bot; pass a channel configuration code in option to target a specific bot or QQ groupQQ channel guide
cpFreeWeCom appWeCom app setup
mailFreeEmailEmail channel guide
smsPaidSMS; paid, 10 Points per messageSMS channel setup
voicePaidVoice call; paid, 30 Points per callVoice channel setup
Return Codes

Response Codes

API response codes

Code

Description

200Success
302Not logged in
401Unauthorized request (check whether the Open API feature is enabled)
403Request IP not authorized (check whether the IP has been added to the Open API allowlist)
500System error, please try again later
600Data error, operation failed
805No permission to view
888Insufficient Points, please top up
900Account restricted (too many requests, stop sending requests)
905Real-name Verification not completed (you can send messages once verified)
903Invalid user token (the token used to send the message is incorrect)
999Server-side validation error (see the response for details)