@woolson/wx-pusher v1.1.0

WxPusher SDK NodeJS版本

特性 Feature

• 使用TS开发
• 完整的类型声明
• 完整的类型注释

安装 Install

npm install -S @woolson/wx-pusher

使用 Usage

引入

import { WxPusher } from '@woolson/wx-pusher';

推送信息

const PUSHER_TEST_TOKEN = '<PRIVATE_TOKEN>';
const TEST_TOPIC = <PRIVATE_TOPIC>;

/** 发送信息简化版 */
const { data: sendMsgSimpleRes } = await WxPusher.msgSendSimple({
  appToken: PUSHER_TEST_TOKEN,
  content: '测试内容',
  summary: '测试',
  topicId: TEST_TOPIC,
});
console.log('发送信息简化版', sendMsgSimpleRes.data, '\n\n');


/** 发送信息 */
const { data: sendMsgRes } = await WxPusher.msgSend({
  appToken: PUSHER_TEST_TOKEN,
  content: '测试内容',
  summary: '测试',
  topicIds: [TEST_TOPIC],
});
console.log('发送信息', sendMsgRes.data, '\n\n');

查询信息状态

const { data: messageStatus } = await WxPusher.msgStatusGet(71126666)
console.log('获取信息状态', messageStatus.data, '\n\n');

创建二维码

const { data: qrcodeRes } = await WxPusher.qrcodeCreate({
  appToken: PUSHER_TEST_TOKEN,
  extra: 'Test_Code',
})
console.log('创建二维码', qrcodeRes.data, '\n\n');

查询用户列表

const { data: userList } = await WxPusher.userListGet({
  appToken: PUSHER_TEST_TOKEN,
  page: 1,
  pageSize: 10,
})
console.log('查询用户列表', userList.data, '\n\n');

const { data: userList } = await WxPusher.userListGet({
  appToken: PUSHER_TEST_TOKEN,
  page: 1,
  pageSize: 10,
  uid: '<USER_ID>'
})
console.log('查询具体用户信息', userList[0].data, '\n\n');

类型声明 Type Declaration

// ============== 基础部分 ==============
/* 接口列表 */
export enum SendApis {}

/** 接口返回编码 */
export enum ResultCode {}

/** 用户来源 */
export enum UserSource {}

/** 用户关注类型 */
export enum UserSubscribeType {}

/** 请求返回统一结构 */
export interface ResBase<T> {}

/** 分页通用部分 */
export interface PaginationBase {}

// ============== 消息推送 ==============
/* 推送内容类型 */
export enum MsgContentType {}

/* 通知消息请求体 */
export interface MsgSendReqBase {}

/* 简单发送消息请求参数 */
export interface MsgSendReqParams {}

/* 全功能发送消息请求体 */
export interface MsgSendReqBody {}

/** 发送消息响应内容项 */
export interface MsgSendResDataItem {}

// ============== 创建二维码 ==============
/** 创建二维码请求参数 */
export interface QrcodeCreateReqBody {}

/** 创建二维码响应内容 */
export interface QrcodeCreateResData {}

// ============== 用户信息 ==============
/**
 * 查询用户列表请求参数
 * @deprecated 请使用UserListGetReqParamsV2
 */
export interface UserListGetReqParams {}

/**
 * 获取用户列表响应内容
 * @deprecated 请使用UserListGetResDataV2
 */
export interface UserListGetResData {}

/**
 * 获取用户列表响应用户信息
 * @deprecated 请使用UserListGetResDataItemV2
 */
export interface UserListGetResDataItem {}

/** 查询用户列表请求参数V2 */
export interface UserListGetReqParamsV2 {}

/** 获取用户列表响应内容V2 */
export interface UserListGetResData {}

/** 获取用户列表响应内容V2 */
export interface UserListGetResDataItemV2 {}

// ============== 公众号互动 ==============
/** 公众号事件互动类型 */
export enum EventActionType {}

/** 调用事件类型及相关数据 */
export interface EventData {}

/** 调用事件数据部分 */
export interface EventDataBase {}

/** 用户关注时间消息回调数据 */
export interface EventSubscribeData {}

/** 上行事件消息回调数据 */
export interface EventUpCmdData {}