README
egg-szjcomo-dyw
Install
$ npm i egg-szjcomo-dyw --save
Usage
// {app_root}/config/plugin.js
exports.szjcomoDyw = {
enable: true,
package: 'egg-szjcomo-dyw',
};
Configuration
// {app_root}/config/config.default.js
exports.szjcomoDyw = {
/**
* [accesskey 平台分配给用户的accesskey]
* @type {String}
*/
accesskey:'xxxx',
/**
* [secret 平台分配给用户的secret]
* @type {String}
*/
secret:'xxxx',
/**
* [sign 可传项 单项目建议配置上]
* @type {String}
*/
sign:'xxx'
};
see config/config.default.js for more detail.
API接口
/**
* [send_single 发送单条短信]
* @author szjcomo
* @createTime 2020-08-08
* @param {Object} options
* options.data.accesskey [平台分配给用户的accesskey，登录系统首页可点击"我的秘钥"查看] [可传 不传依赖全局配置项]
* options.data.secret [平台分配给用户的secret，登录系统首页可点击"我的秘钥"查看] [可传 不传依赖全局配置项]
* options.data.sign [平台上申请的接口短信签名或者签名ID（须审核通过），采用utf8编码] [可传 不传依赖全局配置项]
* options.data.templateId [平台上申请的接口短信模板Id（须审核通过）] [必传]
* options.data.mobile [接收短信的手机号码(只支持单个手机号)] [必传]
* options.data.content [发送的短信内容是模板变量内容，多个变量中间用##或者$隔开，采用utf8编码] [必传]
* @return {[type]} [description]
*/
app.send_single:async function(options = {})
/**
* [send_all 批量发送短信]
* @author szjcomo
* @createTime 2020-08-08
* @param {Object} options [description]
* options.data.accesskey [平台分配给用户的accesskey，登录系统首页可点击"我的秘钥"查看] [可传 不传依赖全局配置项]
* options.data.secret [平台分配给用户的secret，登录系统首页可点击"我的秘钥"查看] [可传 不传依赖全局配置项]
* options.data.sign [平台上申请的接口短信签名或者签名ID（须审核通过），采用utf8编码] [可传 不传依赖全局配置项]
* options.data.templateId [平台上申请的接口短信模板Id（须审核通过）] [必传]
* options.data.mobile [接收短信的手机号码，多个号码以半角逗号,隔开 注：最大支持5万] [必传]
* options.data.scheduleSendTime [短信定时发送时间，格式为：2018-01-01 18:00:00；参数如果为空表示立即发送] [可传]
* options.data.data [该字段用于发送个性短信，mobile和content字段不需要填写，该字段json字符串，json的key是手机号，value是短信内容变量，等同于上面的content 包含多个变量中间用##或者$隔开，采用utf8编码] [可传]
* 示列 {"13700000001":"女士##10:10##物流公司##000000","13700000000":"先生##9:40##快递公司##1234567"}
* @return {[type]} [description]
*/
app.send_all:async function(options = {})
/**
* [create_sign 创建短信签名]
* @author szjcomo
* @createTime 2020-08-08
* @param {Object} options [description]
* options.data.accesskey [平台分配给用户的accesskey，登录系统首页可点击"我的秘钥"查看] [可传 不传依赖全局配置项]
* options.data.secret [平台分配给用户的secret，登录系统首页可点击"我的秘钥"查看] [可传 不传依赖全局配置项]
* options.data.sign [平台上申请的接口短信签名或者签名ID（须审核通过），采用utf8编码] [必传 示例【测试签名】]
* options.data.description [简单描述使用场景] [可传 ]
* @return {[type]} [description]
*/
app.create_sign:async function(options = {})
/**
* [update_sign 更新签名]
* @author szjcomo
* @createTime 2020-08-13
* @param {Object} options [description]
* options.data.accesskey [平台分配给用户的accesskey，登录系统首页可点击"我的秘钥"查看] [可传 不传依赖全局配置项]
* options.data.secret [平台分配给用户的secret，登录系统首页可点击"我的秘钥"查看] [可传 不传依赖全局配置项]
* options.data.sign [平台上申请的接口短信签名或者签名ID（须审核通过），采用utf8编码] [必传 示例【测试签名】]
* options.data.id [签名id] [必传 示例【测试签名】]
* options.data.description [简单描述使用场景] [可传 ]
* @return {[type]} [description]
*/
app.update_sign:async function(options = {})
/**
* [select_sign 查询所有签名]
* @author szjcomo
* @createTime 2020-08-13
* @param {Object} options [description]
* @return {[type]} [description]
*/
app.select_sign:async function(options = {})
/**
* [create_template 创建模版]
* @author szjcomo
* @createTime 2020-08-08
* @param {Object} options [description]
* options.data.accesskey [平台分配给用户的accesskey，登录系统首页可点击"我的秘钥"查看] [可传 不传依赖全局配置项]
* options.data.secret [平台分配给用户的secret，登录系统首页可点击"我的秘钥"查看] [可传 不传依赖全局配置项]
* options.data.templateName [模板名称] [必传 示例【模板名称】]
* options.data.categoryId [模板类型] [必传 1 验证码 2 通知||订单 3 营销]
* options.data.template [短信模板，采用utf8编码] [必传 示例 你的验证码是{1}]
* options.data.description [简单描述使用场景] [必传 示例 公司名称]
* @return {[type]} [description]
*/
app.create_template:async function(options = {})
/**
* [update_templdate 修改模版]
* @author szjcomo
* @createTime 2020-08-13
* @param {Object} options [description]
* options.data.accesskey [平台分配给用户的accesskey，登录系统首页可点击"我的秘钥"查看] [可传 不传依赖全局配置项]
* options.data.secret [平台分配给用户的secret，登录系统首页可点击"我的秘钥"查看] [可传 不传依赖全局配置项]
* options.data.templateName [模板名称] [必传 示例【模板名称】]
* options.data.id [模板ID] [示例 1]
* options.data.template [短信模板，采用utf8编码] [必传 示例 你的验证码是{1}]
* options.data.description [简单描述使用场景] [必传 示例 公司名称]
* @return {[type]} [description]
*/
app.update_templdate:async function(options = {})
/**
* [select_template 短信所有模版查询]
* @author szjcomo
* @createTime 2020-08-08
* @param {Object} options [description]
* options.data.accesskey [平台分配给用户的accesskey，登录系统首页可点击"我的秘钥"查看] [可传 不传依赖全局配置项]
* options.data.secret [平台分配给用户的secret，登录系统首页可点击"我的秘钥"查看] [可传 不传依赖全局配置项]
* @return {[type]} [description]
*/
app.select_template:async function(options = {})
/**
* [find_template 模版详情]
* @author szjcomo
* @createTime 2020-08-08
* @param {Object} options [description]
* options.data.accesskey [平台分配给用户的accesskey，登录系统首页可点击"我的秘钥"查看] [可传 不传依赖全局配置项]
* options.data.secret [平台分配给用户的secret，登录系统首页可点击"我的秘钥"查看] [可传 不传依赖全局配置项]
* options.data.templateId [模板ID] [必传 示例 1]
* @return {[type]} [description]
*/
app.find_template:async function(options = {})
/**
* [phone_info 手机号码所在地查询]
* @author szjcomo
* @createTime 2020-08-08
* @param {Object} options [description]
* options.data.accesskey [平台分配给用户的accesskey，登录系统首页可点击"我的秘钥"查看] [可传 不传依赖全局配置项]
* options.data.secret [平台分配给用户的secret，登录系统首页可点击"我的秘钥"查看] [可传 不传依赖全局配置项]
* options.data.mobiles [多个手机号用英文逗号分开] [必传 手机号]
* @return {[type]} [description]
*/
app.phone_info:async function(options = {})
/**
* [dw_status 获取短信状态]
* @author szjcomo
* @createTime 2020-08-08
* @param {Object} options [description]
* options.data.accesskey [平台分配给用户的accesskey，登录系统首页可点击"我的秘钥"查看] [可传 不传依赖全局配置项]
* options.data.secret [平台分配给用户的secret，登录系统首页可点击"我的秘钥"查看] [可传 不传依赖全局配置项]
* @return {[type]} [description]
*/
app.dw_status:async function(options = {})
/**
* [account_money 账户余额查询]
* @author szjcomo
* @createTime 2020-08-08
* @param {Object} options [description]
* options.data.accesskey [平台分配给用户的accesskey，登录系统首页可点击"我的秘钥"查看] [可传 不传依赖全局配置项]
* options.data.secret [平台分配给用户的secret，登录系统首页可点击"我的秘钥"查看] [可传 不传依赖全局配置项]
* @return {[type]} [description]
*/
app.account_money:async function(options = {})
/**
* [get_user_reply 获取用户回复的信息]
* @author szjcomo
* @createTime 2020-08-13
* @param {Object} options [description]
* @return {[type]} [description]
*/
select_replys:async function(options = {})