推荐一款好用的消息推送服务WxPusher

目录

一、什么是WxPusher？

二、 官网地址

1、在线文档地址

2、在线demo演示

三、快速入门

1、注册并创建应用

2、扫码关注应用

3、获取UID

4、发送消息

四、常用HTTP接口详解

1、发送消息（post方式）

2、发送消息（get方式）

3、查询状态

4、创建参数二维码

5、 查询关注该应用的用户

6、删除用户

7、拉黑用户

五、限制说明

---

 

一、什么是WxPusher？

WxPusher (微信推送服务)是一个使用微信公众号作为通道的，实时信息推送平台，你可以通过调用API的方式，把信息推送到微信上，无需安装额外的软件，即可做到信息实时通知。 你可以使用WxPusher来做服务器报警通知、抢课通知、抢票通知，信息更新提示等。

二、 官网地址

1、在线文档地址#

https://wxpusher.zjiecode.com/docs/#/

2、在线demo演示#

http://wxpusher.zjiecode.com/demo/

三、快速入门

1、注册并创建应用#

访问： http://wxpusher.zjiecode.com/admin/ ，使用微信扫码登录，无需注册，新用户首次扫码自动注册。

 

回调地址：可以不填写，不填写用户关注的时候，就不会有回调，你不能拿到用户的UID。

设置URL：可以不填写，填写以后，用户在微信端打开「我的订阅」，可以直接跳转到这个地址，并且会携带uid作为参数，方便做定制化页面展示。

联系方式：可以不填写，告诉用户，如何联系到你，给你反馈问题。

关注提示：用户关注或者扫应用码的时候发送给用户的提示，你可以不填写，Wxpusher会提供一个默认文案。你也可以在用户关注回调给你UID的时候，再主动推送一个提示消息给用户。

说明：描述一下，你的应用，推送的是啥内容，用户通过链接关注，或者在微信端查看的时候可以看到。

2、扫码关注应用#

创建应用以后，你可以看到应用的应用码和关注链接，你可以让你的用户通过下面2种方式来关注你的应用，关注你的应用以后，你就可以给他发送消息了。

3、获取UID#

 关注公众号：wxpusher，然后点击「我的」-「我的UID」查询到UID。

4、发送消息#

拿到UID以后，配合应用的appToken，然后调用发送接口发送消息。

四、常用HTTP接口详解

1、发送消息（post方式）#

headers：Content-Type:application/json

API地址：http://wxpusher.zjiecode.com/api/send/message

请求数据放在body里面，具体参数如下：

{
  "appToken":"AT_xxx",
  "content":"Wxpusher祝你中秋节快乐!",
  "summary":"消息摘要",//消息摘要，显示在微信聊天页面或者模版消息卡片上，限制长度100，可以不传，不传默认截取content前面的内容。
  "contentType":1,//内容类型 1表示文字  2表示html(只发送body标签内部的数据即可，不包括body标签) 3表示markdown 
  "topicIds":[ //发送目标的topicId，是一个数组！！！，也就是群发，使用uids单发的时候， 可以不传。
      123
  ],
  "uids":[//发送目标的UID，是一个数组。注意uids和topicIds可以同时填写，也可以只填写一个。
      "UID_xxxx"
  ],
  "url":"http://wxpusher.zjiecode.com" //原文链接，可选参数
}

2、发送消息（get方式）#

GET接口 GET接口是对POST接口的阉割，主要是为了某些情况下调用方便，只支持对文字（contentType=1）的发送，例如：

http://wxpusher.zjiecode.com/api/send/message/?appToken=AT_qHT0cTQfLwYOlBV9cJj9zDSyEmspsmyM&content=123&uid=c1BcpqxEbD8irqlGUh9BhOqR2BvH8yWZ&url=http%3a%2f%2fwxpusher.zjiecode.com

3、查询状态#

消息发送给Wxpusher，Wxpusher会缓存下来，后台异步推送给微信再分发给用户，当消息数量庞大的时候，可能会有延迟，你可以根据发送消息返回的messageId，查询消息的发送状态

请求方式：GET

说明：查询消息状态，消息缓存有时效性，目前设置缓存时间为7天，7天后查询消息，可能会返回消息不存在

请求地址：http://wxpusher.zjiecode.com/api/send/query/{messageId}

4、创建参数二维码#

#

有一种场景，就是需要知道当前是谁扫描的二维码，比如：论坛帖子有新消息需要推送给用户，这个如果用户扫码关注，你需要知道是谁扫的二维码，把论坛用户ID和Wxpusher用户的UID绑定，当论坛用户ID有新消息时，推送给Wxpusher用户。这种场景就需要带参数的二维码。

请求方式：POST

请求地址：http://wxpusher.zjiecode.com/api/fun/create/qrcode

ContentType：application/json

说明：创建带参数二维码，用户扫码以后，会在回调里面带上参数，参考回调说明

请求body:

{
    "appToken":"xxx",   //必填，appToken,前面有说明，应用的标志
    "extra":"xxx",      //必填，二维码携带的参数，最长64位
    "validTime":1800    //可选，二维码的有效期，默认30分钟，最长30天，单位是秒
}

5、 查询关注该应用的用户#

你可以通过本接口，分页查询到所有关注应用和关注主题的用户。

请求方式：GET

说明：获取到所有关注应用/主题的微信用户用户信息。需要注意，一个微信用户，如果同时关注应用，主题，甚至关注多个主题，会返回多条记录。

请求地址：http://wxpusher.zjiecode.com/api/fun/wxuser/v2

请求参数：

• appToken 应用密钥标志
• page 请求数据的页码
• pageSize 分页大小，不能超过100
• uid 用户的uid，可选，如果不传就是查询所有用户，传uid就是查某个用户的信息。
• isBlock 查询拉黑用户，可选，不传查询所有用户，true查询拉黑用户，false查询没有拉黑的用户
• type 关注的类型，可选，不传查询所有用户，0是应用，1是主题。 返回数据：

  {
   "code": 1000,
   "msg": "处理成功",
   "data": {
       "total": 40,//总数
       "page": 1,//当前页码
       "pageSize": 20,//页码大小，
       "records": [
           {
               "uid": "UID_xxx",//用户uid
               "headImg": "http://thirdwx.qlogo.cn/mmopen/xxx/132",//最后一个数值代表正方形头像大小（有0、46、64、96、132数值可选，0代表640*640正方形头像），用户没有头像时该项为空
               "createTime": 1603540859285,//创建时间
               "nickName": "Li",//昵称
               "reject": false,//是否拉黑
               "id": 47361,//id，如果调用删除或者拉黑接口，需要这个id
               "type": 0,//关注类型，0：关注应用，1：关注topic
               "target": "WxPusher官方"//关注的应用或者主题名字
           }
       ]
   },
   "success": true
  }

#

 6、删除用户#

你可以通过本接口，删除用户对应用，主题的关注。

请求方式：DELETE

说明：你可以删除用户对应用、主题的关注，删除以后，用户可以重新关注，如想让用户再次关注，可以调用拉黑接口，对用户拉黑。

请求地址：http://wxpusher.zjiecode.com/api/fun/remove

请求参数：

• appToken 应用密钥标志
• id 用户id，通过用户查询接口可以获取

返回数据：

{
    "code": 1000,
    "msg": "处理成功",
    "data": "删除成功",
    "success": true
}

 7、拉黑用户#

你可以通过本接口，可以拉黑用户

请求方式：PUT

说明：拉黑以后不能再发送消息，用户也不能再次关注，除非你取消对他的拉黑。调用拉黑接口，不用再调用删除接口。

请求地址：http://wxpusher.zjiecode.com/api/fun/reject

请求参数：

• appToken 应用密钥标志
• id 用户id，通过用户查询接口可以获取
• reject 是否拉黑，true表示拉黑，false表示取消拉黑

返回数据：

{
    "code": 1000,
    "msg": "处理成功",
    "data": "删除成功",
    "success": true
}

五、限制说明

WxPusher是免费的推送服务，为了能更好的服务大家，这里说明一下系统相关数据限制

• 消息发送频率没有做限制，但是请控制在合理范围内。不排除后期做频率限制的可能，但是这样做也是为了更好的体验，只要在合理范围内，不会受到影响；
• 消息发送，必须合法合规，发送违规违法欺诈等等非正常消息，可能被封号；
• WxPusher推送的是实时消息，时效性比较强，过期以后消息也就没有价值了，目前WxPusher会为你保留7天的数据 ，7天以后不再提供可靠性保证，会不定时清理历史消息；
• 单条消息的数据长度(字符数)限制是：content<40000;summary<100;url<400;
• 单条消息最大发送UID的数量<2000，单条消息最大发送topicIds的数量<5;