egg-wx v1.0.19

egg-wx

Install

$ npm i egg-wx --save
$ npm install xml2js egg-redis --save

Usage

// {app_root}/config/plugin.js
exports.wx = {
  enable: true,
  package: 'egg-wx',
};

Configuration

// {app_root}/config/config.default.js
config.bodyParser = {
  extendTypes: {
    text: [ 'application/xml', 'text/xml', 'text/html' ],
  },
  enableTypes: [ 'text' ],
};

config.wx = {
  redisClient: '', // Set this if used Multi Clients
  redisPrefix: 'egg-wx',
  AppID: 'appid',
  AppSecret: 'app_secret',
  MiniAppID: 'mini_appid', // wechat mini program app id
  MiniAppSecret: 'mini_app_secret', // wechat mini program app secret
  token: 'egg-wx',
  EncodingAESKey: 'EncodingAESKey',
};

see https://mp.weixin.qq.com/wiki for more detail

Example

async index() {
    ctx.body = await app.wx.apiCommon.getAccessToken();
}

Classes

ApiCommon

微信基本接口，包含获取AccessToken

Kind: global class

• ApiCommon
  • .getRedisCache() ⇒ object
  • .getAccessToken(type = 'wx') ⇒ string
  • .getAccessTokenFromApi(type = 'wx') ⇒ string

apiCommon.getRedisCache() ⇒ object

返回Redis对象

Kind: instance method of ApiCommon
Returns: object - redis对象

apiCommon.getAccessToken(type = 'wx') ⇒ string

获取AccessToken,如果cache存在则直接读取chace

Kind: instance method of ApiCommon
Returns: string - AccessToken

apiCommon.getAccessTokenFromApi(type = 'wx') ⇒ string

通过微信接口获取AccessToken

Kind: instance method of ApiCommon
Returns: string - AccessToken

ApiCustom

客服接口

Kind: global class

• ApiCustom
  • .post(data, type) ⇒ *
  • .addCustomservice(email, nickname, password) ⇒ *
  • .updateCustomservice(email, nickname, password) ⇒ *
  • .deleteCustomservice(email) ⇒ *
  • .getCustomserviceList() ⇒ *
  • .sendText(openid, content) ⇒ *
  • .sendImage(openid, mediaID) ⇒ *
  • .sendVoice(openid, mediaID) ⇒ *
  • .sendVideo(openid, mediaID, thumbMediaID, title, description) ⇒ *
  • .sendMusic(openid, title, description, musicurl, hqmusicurl, thumbMediaID) ⇒ *
  • .sendNews(openid, articles) ⇒ *
  • .sendMpNews(openid, mediaID) ⇒ *
  • .sendWxCard(openid, cardID) ⇒ *

apiCustom.post(data, type) ⇒ *

POST

Kind: instance method of ApiCustom
Returns: * - 返回信息

apiCustom.addCustomservice(email, nickname, password) ⇒ *

添加客服账号

Kind: instance method of ApiCustom
Returns: * - 正常返回true

apiCustom.updateCustomservice(email, nickname, password) ⇒ *

修改客服账号

Kind: instance method of ApiCustom
Returns: * - 正常返回true

apiCustom.deleteCustomservice(email) ⇒ *

删除客服账号

Kind: instance method of ApiCustom
Returns: * - 正常返回true

apiCustom.getCustomserviceList() ⇒ *

获取客服列表

Kind: instance method of ApiCustom
Returns: * - 正常返回true

apiCustom.sendText(openid, content) ⇒ *

发送文字消息

Kind: instance method of ApiCustom
Returns: * - 正常返回true

apiCustom.sendImage(openid, mediaID) ⇒ *

发送图片消息

Kind: instance method of ApiCustom
Returns: * - 正常返回true

apiCustom.sendVoice(openid, mediaID) ⇒ *

发送声音消息

Kind: instance method of ApiCustom
Returns: * - 正常返回true

apiCustom.sendVideo(openid, mediaID, thumbMediaID, title, description) ⇒ *

发送视频消息

Kind: instance method of ApiCustom
Returns: * - 正常返回true

apiCustom.sendMusic(openid, title, description, musicurl, hqmusicurl, thumbMediaID) ⇒ *

发送音乐消息

Kind: instance method of ApiCustom
Returns: * - 正常返回true

apiCustom.sendNews(openid, articles) ⇒ *

发送图文消息

Kind: instance method of ApiCustom
Returns: * - 正常返回true

apiCustom.sendMpNews(openid, mediaID) ⇒ *

发送图文消息

Kind: instance method of ApiCustom
Returns: * - 正常返回true

apiCustom.sendWxCard(openid, cardID) ⇒ *

发送卡券

Kind: instance method of ApiCustom
Returns: * - 正常返回true

ApiJssdk

jssdk接口

Kind: global class

• ApiJssdk
  • .getRedisCache() ⇒ object
  • .getJsapiTicket() ⇒ object
  • .getJsapiTicketFromApi(accessToken) ⇒ object
  • .getSign(url, nonce, timestamp) ⇒ object
  • .getJsapiConfig(url) ⇒ object

apiJssdk.getRedisCache() ⇒ object

返回Redis对象

Kind: instance method of ApiJssdk
Returns: object - redis对象

apiJssdk.getJsapiTicket() ⇒ object

返回jsapi ticket对象,缓存读取

Kind: instance method of ApiJssdk
Returns: object - ticket对象

apiJssdk.getJsapiTicketFromApi(accessToken) ⇒ object

返回jsapi ticket对象,接口返回

Kind: instance method of ApiJssdk
Returns: object - ticket对象

apiJssdk.getSign(url, nonce, timestamp) ⇒ object

返回签名

Kind: instance method of ApiJssdk
Returns: object - 返回签名

apiJssdk.getJsapiConfig(url) ⇒ object

返回jssdk参数

Kind: instance method of ApiJssdk
Returns: object - 前端jssdk配置参数对象 {appId, timestamp, nonceStr, signature}

ApiMenu

自定义菜单接口

Kind: global class

• ApiMenu
  • .createMenu(menuItems) ⇒ boolean
  • .getMenu() ⇒ object
  • .deleteMenu() ⇒ boolean

apiMenu.createMenu(menuItems) ⇒ boolean

创建自定义菜单

Kind: instance method of ApiMenu
Returns: boolean - 创建结果

apiMenu.getMenu() ⇒ object

获取当前自定义菜单结构

Kind: instance method of ApiMenu
Returns: object - 菜单结构

apiMenu.deleteMenu() ⇒ boolean

删除当前自定义菜单

Kind: instance method of ApiMenu
Returns: boolean - 结果

ApiMessage

消息接口

Kind: global class

• ApiMessage
  • .getRandomStr(len) ⇒ string
  • .getIntervalRandom(min, max) ⇒ integer
  • .getObjectFromXml(data) ⇒ object
  • .getXmlFromObject(data) ⇒ object
  • .messageEncrypt(msg) ⇒ string
  • .messageDecrypt(msg) ⇒ string
  • .sendTemplateMessage(openid, template_id, data, jumpUrl, miniprogram = null, type = 'wx') ⇒ string
  • .sendSubscribeMessage(openid, template_id, data, page = null) ⇒ string
  • .checkSign(urlQuery, encryptText) ⇒ boolean
  • .getSign(timestamp, nonce, encryptText) ⇒ string

apiMessage.getRandomStr(len) ⇒ string

返回指定长度的随机字符串

Kind: instance method of ApiMessage
Returns: string - 随机字符串

apiMessage.getIntervalRandom(min, max) ⇒ integer

返回指定整数区间的随机数

Kind: instance method of ApiMessage
Returns: integer - 随机整数

apiMessage.getObjectFromXml(data) ⇒ object

解析xml为对象

Kind: instance method of ApiMessage
Returns: object - 解析结果

apiMessage.getXmlFromObject(data) ⇒ object

解析Object为xml

Kind: instance method of ApiMessage
Returns: object - 解析结果

apiMessage.messageEncrypt(msg) ⇒ string

返回微信消息加密文本

Kind: instance method of ApiMessage
Returns: string - 密文

apiMessage.messageDecrypt(msg) ⇒ string

返回微信消息解密数据

Kind: instance method of ApiMessage
Returns: string - 解密文本

apiMessage.sendTemplateMessage(openid, template_id, data, jumpUrl, miniprogram = null, type = 'wx') ⇒ string

发送模板消息

Kind: instance method of ApiMessage
Returns: string - 发送结果

apiMessage.sendSubscribeMessage(openid, template_id, data, page = null) ⇒ string

发送订阅消息

Kind: instance method of ApiMessage
Returns: string - 发送结果

apiMessage.checkSign(urlQuery, encryptText) ⇒ boolean

校验请求签名

Kind: instance method of ApiMessage
Returns: boolean - 校验结果

apiMessage.getSign(timestamp, nonce, encryptText) ⇒ string

生成签名

Kind: instance method of ApiMessage
Returns: string - 解密结果

ApiMiniProgramSession

小程序获取用户Session接口

Kind: global class

apiMiniProgramSession.getSession(js_code) ⇒ object

小程序通过code获取用户Session

Kind: instance method of ApiMiniProgramSession
Returns: object - jscode2session数据

ApiQRCode

qrcode接口

Kind: global class

apiQRCode.createQRCode(type, sceneValue, expire_seconds) ⇒ object

生成二维码

Kind: instance method of ApiQRCode
Returns: object - 二维码值

ApiServer

服务器验证接口

Kind: global class

apiServer.checkServer(ctx) ⇒ boolean/string

验证消息的确来自微信服务器，微信公众平台接口配置校验

Kind: instance method of ApiServer
Returns: boolean/string - 校验结果

ApiShortUrl

ShortUrl接口

Kind: global class

apiShortUrl.createShortUrl(longurl) ⇒ object

生成二维码

Kind: instance method of ApiShortUrl
Returns: object - 短连接

ApiWebAuth

用户授权接口

Kind: global class

• ApiWebAuth
  • .getUserWebAccessToken(code) ⇒ object
  • .refreshUserWebAccessToken(refresh_token) ⇒ object
  • .getUserWebInfo(access_token, openid, lang) ⇒ object

apiWebAuth.getUserWebAccessToken(code) ⇒ object

通过code获取用户网页授权access_token

Kind: instance method of ApiWebAuth
Returns: object - access_token授权数据

apiWebAuth.refreshUserWebAccessToken(refresh_token) ⇒ object

刷新用户网页授权access_token

Kind: instance method of ApiWebAuth
Returns: object - access_token授权数据

apiWebAuth.getUserWebInfo(access_token, openid, lang) ⇒ object

获取用户信息

Kind: instance method of ApiWebAuth
Returns: object - 用户信息对象