pwechat

push wechat

npm install pwechat
20 downloads in the last week
44 downloads in the last month

pushwechattravis-ci

通过模拟后台登录的形式,进行消息的发送和获取。

用法


var Pusher = require('pwechat');
var pusher = Pusher.create('youremail', 'yourpassword');

pusher.on('PWwchatError', function (err) {
  console.log(err); //无法登录后台
});

/**
 * 给单个用户发送微信消息
 * @param {String} fakeId 用户fakeId
 * @param {String} content 发送内容
 */
pusher.singleSend('12345', 'test content', function (err, data) {
  // 发送成功的响应data.should.eql({ret: 0, msg: 'ok'});
});

//除了可以发送文字外,还支持发送其他的微信资源(在微信素材管理中添加)。  
//type为发送的不同资源类型,不同的类型需要的字段也不同
//发送前需要把要发送的资源上传到微信,并找到对应的`fid`等字段

pusher.singleSend('12345', {
  type: 2, //图片
  fid: 1000002 //图片的资源id
}, function (err, data) {
  // 发送成功的响应data.should.eql({ret: 0, msg: 'ok'});
});

pusher.singleSend('12345', {
  type: 10, //图文
  fid: 1000003,
  fileid: 1000004, 
  appmsgid: 1000003
}, function (err, data) {
  // 发送成功的响应data.should.eql({ret: 0, msg: 'ok'});
});

/**
 * 获取包含关键字的消息
 * @param {String} keyword 消息中包含的关键字
 * @param {Number} count 获取条数
 * @param {Number} fromMsgId 从这个msgId开始往前查找
 */
pusher.getMessage('@help', 10, 1000, function (err, data) {
  // 获取成功的响应,data会是一个数组
});

/**
 * 获取公众账号的粉丝
 * 响应: 
  [{ 
    fakeId: '98106560',
    nickName: 'nick1',
    remarkName: '',
    groupId: '0' 
  }, { 
    fakeId: '3297485',
    nickName: 'nick2',
    remarkName: '',
    groupId: '0' 
  }]
 */
pusher.getUsers(function (err, data) {});

/**
 * 获取单个用户详情, 包括所有分组
 * @param {String}   fakeId   用户的fakeId
 * @param {Function} callback
 * 响应:
{ "FakeId" : "12345",
  "NickName" : "Jane Doe",
  "ReMarkName" : "",
  "Username" : "wxid_12345",
  "Signature": "",
  "Country" : "中国",
  "Province" : "河南",
  "City" : "安阳",
  "Sex" : "1",
  "GroupID" : "0",
  "Groups"  : [
    { "GroupId": "0", "GroupName": "未分组" },
    { "GroupId": "1", "GroupName": "黑名单" },
    { "GroupId": "2", "GroupName": "星标组" }
  ]
}
 */
pusher.getUserDetail('12345', function (err, data) {});

/**
 * 修改用户分组, 每个用户只能分一组
 * @param  {[String]}   fakeId 用户的fakeId
 * @param  {[String]}   userGroupId 分组Id
 * @param  {Function} callback
 * 响应:
{ "ret":"0",
  "result": [
    {"fakeId":"12345","ret":"0"}
  ]
}
 */
pusher.modifyUserGroup('12345', '100', function (err, data) {});


/**
 * 添加分组
 * @param {[String]}   groupName 分组名称
 * @param {Function} callback 
 * 响应:
{ "ErrCode":"",
  "ErrMsg":"",
  "GroupId":"103",
  "GroupName":"apple",
  "MemberCnt":"0"
}
 */
pusher.addGroup('apple', function (err, data) {});

/**
 * 重命名分组
 * @param  {[String]}   groupId   分组ID
 * @param  {[String]}   groupName 新的分组名称
 * @param  {Function}   callback
 * 响应:
{ "ErrCode":"",
  "ErrMsg":"",
  "GroupId":"100",
  "GroupName":"hello",
  "MemberCnt":"0"
}
 */
pusher.renameGroup('100', 'orange', function (err, data) {});


/**
 * 删除分组
 * @param  {[String]}   groupId   分组ID
 * @param  {Function}   callback
 * 响应:
{ "ErrCode":"",
  "ErrMsg":"",
  "GroupId":"100",
  "GroupName":"",
  "MemberCnt":"0"
}
 */
pusher.deleteGroup('100', function (err, data) {});


/**
 * 获取公众账号的上载媒体列表
 * @param {String} type 媒体类别 2为图片, 3为语音, 4为视频, 10为图文
 * @param {Function} callback
 * 响应:
[
{ id: '10000000',
  fileName: '2013082810294238334.jpg',
  type: '2',
  size: '30.6 K',
  dateTime: 1378618280,
  length: '0' }
{ id: '10000004',
  fileName: '2013082608430532299.gif',
  type: '2',
  size: '3.0 K',
  dateTime: 1378623899,
  length: '0' }
{ id: '10000006',
  fileName: '0.jpg',
  type: '2',
  size: '55.3 K',
  dateTime: 1378780173,
  length: '0' }
]
 */
pusher.getMedia('2', function (err, data) {});

安装

npm install pwechat

贡献者们

$ git summary

 project  : weixin-push
 repo age : 7 months ago
 commits  : 40
 active   : 14 days
 files    : 13
 authors  : 
    22  dead-horse              55.0%
     9  不四                  22.5%
     5  dead_horse              12.5%
     2  Angela Zou              5.0%
     1  Xiayu                   2.5%
     1  hsinglin                2.5%

Lincense

(The MIT License)

Copyright (c) 2012 dead-horse and other contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you