微信小程序(验证码) SDK 开发文档

微信小程序验证码SDK增加专用于发送验证码的接口，可以实现验证码的生成、存储、发送、校验功能。

1.安装

下载后的SDK只包含一个zhenzisms.js文件,可直接放在utils文件夹中，然后通过require引入，如下:

var zhenzisms = require('../../utils/zhenzisms.js');

2.配置域名

在微信公众平台-小程序管理中配置域名https://sms.zhenzikj.com,如下图:

3.用法

使用事先申请的appId、appSecret初始化:

appId、appSecret的获取请参考准备

zhenzisms.client.init(apiUrl, appId, appSecret);

apiUrl为请求地址，个人开发者使用https://sms_developer.zhenzikj.com，企业开发者使用https://sms.zhenzikj.com

1)发送短信(通用)

var params = {}; params.number = '18511111111'; params.templateId = '13'; //生成验证码，参数1:验证码位数，参数2:验证码有效期(秒),参数3:手机号码 var code = zhenzisms.client.createCode(4, 300, params.number); var templateParams = [code, '5分钟']; params.templateParams = templateParams; // params.messageId = '1111111'; // params.clientIp = '221.221.221.111'; // console.log(code); zhenzisms.client.send(function (res) { wx.showToast({ title: res.data.data, icon: 'none', duration: 2000 }) }, params);

send方法用于单条发送短信,所有请求参数需要封装到json对象中

使用createCode方法生成的验证码可以通过validateCode方法校验

所有请求参数请参考下表

返回结果是json格式的字符串, code: 发送状态，0为成功。非0为发送失败，可从data中查看错误信息

注: 测试发送短信内容不要使用"你好"或"12132"全数字形式，这种短信内容没有具体的意义，可能会被运营商屏蔽

			{
			    "code":0,
			    "data":"发送成功"
			}
			

请求参数

参数名称	必选	类型	描述
templateId	是	string	短信模板ID，登录用户中心，在"短信管理->短信模板"中创建，并查看
templateParams	否	string[]	短信模板参数
number	是	string	接收者手机号码
messageId	否	string	messageId即该条短信的唯一标识, 不能重复
clientIp	否	string	客户端IP，需要与应用设置中的”客户IP限额“配合使用，主要防止用户恶意刷短信

错误代码表

错误码	原因	解决方案
100	参数格式错误	检查请求参数是否为空, 或手机号码格式错误
101	短信内容超过1000字	短信内容过长，请筛检或分多次发送
105	appId错误或应用不存在	请联系工作人员申请应用或检查appId是否输入错误
106	应用被禁止	请联系工作人员查看原因
107	ip错误	如果设置了ip白名单，系统会检查请求服务器的ip地址，已确定是否为安全的来源访问
108	短信余额不足	需要到用户中心进行充值
109	今日发送超过限额	如果设置了日发送数量，则每个接收号码不得超过这个数量
110	应用秘钥(AppSecret)错误	检查AppSecret是否输入错误，或是否已在用户中心进行了秘钥重置
111	账号不存在	请联系工作人员申请账号
117	templateId错误，或者模板未审核	错误说明
1000	系统位置错误	请联系工作人员或技术人员检查原因

2)校验验证码

检验用户输入的验证码是否和发送的一致

            var result = zhenzisms.client.validateCode(number, code);
            

参数number:发送短信的手机号码

参数code:用户输入的验证码

返回结果是字符串, ok: 校验成功，empty：未生成验证码, number_error: 手机号码不一致, code_error:验证码不一致, code_expired:验证码已过期

3)查看余额

通过该接口可查看当前剩余的短信条数

zhenzisms.client.balance(function(res){
               console.log(res.data)
            });
			

返回结果是json格式的字符串, code: 查询状态，0为成功，data为剩余短信条数。非0为查询失败，可从data中查看错误信息

错误代码表

错误码	原因	解决方案
100	参数格式错误	检查请求参数是否为空
105	appId错误或应用不存在	请联系工作人员申请应用或检查appId是否输入错误
106	应用被禁止	请联系工作人员查看原因
107	ip错误	如果设置了ip白名单，系统会检查请求服务器的ip地址，已确定是否为安全的来源访问
110	应用秘钥(AppSecret)错误	检查AppSecret是否输入错误，或是否已在用户中心进行了秘钥重置
1000	系统位置错误	请联系工作人员或技术人员检查原因

4)查询短信

接口描述

根据messageId查询已发送短信

zhenzisms.client.findSmsByMessageId(function(res){
               console.log(res.data)
            }, 'dfee_dfdw_xdfd_dfdfd');
			

请求参数

参数名称	必选	类型	描述
messageId	是	string	信息id，对应发送短信接口的messageId字段

返回结果

返回结果是json格式的字符串, code: 查询状态，0为成功。非0为失败，可从data中查看错误信息

			{
			    "code":0,
			    "data":{}
			}
			

返回结果是json格式的字符串, code: 查询状态，0为成功，data短信信息的json字符串