0.1.0 • Published 7 years ago

@neuroo_fe/wechat-template-mass v0.1.0

Weekly downloads
1
License
ISC
Repository
github
Last release
7 years ago

wechat-template-mass

微信模版消息群发功能模块。

Usage

npm install @neuroo_fe/wechat-template-mass -S
const MassFactory = require('wechat-template-mass')
const massFactory = new MassFactory(appId, appSecret [,getTokenFunction])

const openIds = [ 'oDetxwdKb1uyCTogQzFvYymlrcLc' ]
const concurrent = 10
const templateId = 'D_vgWaYRVADAtXKYPxWPlsRQ5tBY3R70Hig4W_LhsX8'
const url = 'https://google.com/'
const data = {
  first: {
    value: '测试内容',
    color: '#000000'
  },
  remark: {
    value: '测试内容',
    color: '#000000'
  }
}

const mass = massFactory.createMass(openIds, concurrent, templateId, url, data)

mass.on('finish', console.log)

mass.start()

/*
{ ok: 0,
  fail: 1,
  complete: 1,
  total: 1,
  startTime: '2017-8-18 14:53:41',
  endTime: '2017-8-18 14:53:45',
  duration: 23 }
*/

MassFactory 构造函数

new MassFactory(appId, appSecret, getTokenFunction)

生成一个MassFactory实例对象

参数

名称类型必填描述
appIdString微信公众号appId
appSecretString微信公众号appSecret
getTokenFunctionString获取公众号接口access_token方法

注意:需要传入 appIdgetTokenFunction 其中一个。

返回值

MassFactory实例对象。

MassFactory 实例方法

createMass

生成 Mass 实例

参数

名称类型必填描述
openIdsArray群发目标的openId数组
concurrentNumber并发数
templateIdString模板Id
urlString模板点击后跳转的URL
dataObject模板插值的填充数据

返回值

Mass 实例对象。

Mass 实例方法

start

开始群发任务。重复调用无效。

stop

停止群发任务。重复调用无效,先恢复后才能再次暂停。

resume

恢复群发任务。重复调用无效,先暂停后才能再次恢复。

Mass 实例事件

ok

当群发的消息中有一条成功时触发。参数为result对象。

result 对象属性

名称类型描述
openIdString用户openId
statusString发送状态

fail

当群发的消息中有一条失败时触发。参数为result对象。

result 对象属性

名称类型描述
openIdString用户openId
statusString发送状态
responseObject错误对象

finish

当全部群发完成时触发。参数为result对象。

result 对象属性

名称类型描述
okNumber成功数量
failNumber失败数量
completeNumber完成的数量
totalNumber总数量。一般应该等于complete
startTimeString开始发送的时间。
endTimeString完成时的时间。
durationNumber发送的持续时间。单位:ms。当调用stop()方法暂停发送时,只在重新调用resume()方法恢复发送时才会重新计算duration,因此中间的等待时间不计入此属性。

progress

进度事件。参数为result对象。

result 对象属性

名称类型描述
okNumber成功数量
failNumber失败数量
completeNumber完成的数量
totalNumber总数量。一般应该等于complete
percentString进度百分比。