node-weixin-user
v0.6.0
Published
user apis for weixin
Downloads
37
Readme
node-weixin-user
node weixin module for use or its management 微信用户API和命令行工具
微信用户API是(node-weixin-api 或者 node-weixin-express)的一个子项目。 它提供:
- 菜单API共计8个:
list: 列举订阅用户
profile: 返回用户资料
remark: 修改昵称
group.get: 获取组列表
group.create: 创建新组
group.in: 获取用户组名
group.update: 更新组名
group.move: 修改用户组属性
- 所有数据返回格式采用json,并与腾讯api上说明一致。回调函数格式如下: function(error, json) { //error为false表示返回正常 //json对应api说明 }
交流QQ群: 39287176
注:
node-weixin-express是基于node-weixin-*的服务器端参考实现。
node-weixin-api是基于node-weixin-*的API接口SDK。
它们都是由下列子项目组合而成:
node-weixin-config 用于微信配置信息的校验
node-weixin-auth 用于与微信服务器握手检验
node-weixin-util 一些常用的微信请求,加密,解密,检验的功能与处理
node-weixin-request 微信的各类服务的HTTP请求的抽象集合
node-weixin-oauth 微信OAuth相关的操作
node-weixin-pay 微信支付的服务器接口
node-weixin-jssdk 微信JSSDK相关的服务器接口
node-weixin-menu 微信菜单相关的操作与命令
Install
$ npm install --save node-weixin-user
Usage
var nodeWeixinUser = require('node-weixin-user');
var settings = require('node-weixin-settings');
var app = {
id: process.env.APP_ID,
secret: process.env.APP_SECRET,
token: process.env.APP_TOKEN
};
var auth = require("node-weixin-auth");
var config = require("node-weixin-config");
config.app.init(app);
//用户操作
//更新备注
nodeWeixinUser.remark(settings, app, process.env.APP_OPENID, '新备注', function (error, data) {
});
//获取用户信息
nodeWeixinUser.profile(settings, app, process.env.APP_OPENID, function (error, data) {
});
//获取用户列表
nodeWeixinUser.list(settings, app, null, function (error, data) {
});
//组操作
//获取组信息
nodeWeixinUser.group.get(settings, app, function (error, data) {
});
//创建组
nodeWeixinUser.group.create(settings, app, 'hello', function (error, data) {
});
//获取用户组名
nodeWeixinUser.group.in(settings, app, openid, function (error, data) {
});
//更新组信息
nodeWeixinUser.group.update(settings, app, gGroup.id, 'new name', function (error, data) {
});
//移动用户组属性
nodeWeixinUser.group.move(settings, app, gGroup.id, process.env.APP_OPENID, function (error, data) {
});
License
Apache-2.0 © calidion