微信小程序(云函数) SDK 开发文档

本SDK是用于使用微信小程序云函数开发的,提供了通用的短信发送方法send,和支持短信验证码管理的方法sendCode,可以实现验证码的生成、存储、比对、有效期管理等,总之,您不需要单独在实现这样的功能,我们都为您做好了。

1.安装

下载后的SDK在cloudfunctions文件夹下会包含zhenzisms文件夹,您直接把这个文件夹拷到您的项目中即可。

miniprogram文件夹下包含使用示例,您可以参考这个完成开发。

注: 使用云函数开发无需配置域名的

2.申请账号,获取AppId、AppSecret

免费注册地址: http://sms_developer.zhenzikj.com/zhenzisms_user/register.html

使用注册账号登录用户中心,在"我的应用"-> "详情"中可以查询AppId、AppSecret

AppId、AppSecret是用于开发者使用账号和秘钥, 以下的所有api中都需要用到

3.修改SDK中的AppId、AppSecret

打开SDK中云函数的index.js文件,填写appId、appSecret

4.发送短信(通用)

此方法send是发送短信的通用方法,如果您想发送短信验证码请使用sendCode

wx.cloud.callFunction({
      name: 'zhenzisms',
      data: {
        $url: 'send',
        apiUrl: 'https://sms_developer.zhenzikj.com',
        message: '你的验证码为:8888',
        number: '15811111111',
        messageId: 'aaabbb'
      }
    }).then((res) => {
      console.log(res.result.msg);
    }).catch((e) => {
      //console.log(e);
    });

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

send方法用于单条发送短信

参数$url:方法名称,固定不变的

参数message:发送的短信内容

参数number:接收者手机号码

参数messageId:该条信息的唯一标识,可用于查询

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

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

5.发送短信(验证码)

此方法sendCode是专用于发送短信验证码的,调用该方法会自动生成验证码并存储在数据库中,当用户提交信息后可以通过validateCode方法比对验证码是否正确。

首先,您需要在云开发控制台中创建名称为sms-record的集合,用于存放验证码信息的,这个集合您无需维护。如下图:

其次,修改集合的权限,如下图:

使用方法:

wx.cloud.callFunction({
      name: 'zhenzisms',
      data: {
        $url: 'sendCode',
        apiUrl: 'https://sms_developer.zhenzikj.com',
        message: '您的验证码为:{code}',
        number: '18511111111',
        messageId: 'aaabbb',
        seconds: 60,
        length: 4
      }
    }).then((res) => {
      console.log(res.result.msg);
    }).catch((e) => {
      //console.log(e);
    });

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

send方法用于单条发送短信

参数$url:方法名称,固定不变的

参数message:发送短信的模板,您可以修改成您需要的,其中{code}会自动替换为验证码的

参数number:接收者手机号码

参数messageId:该条信息的唯一标识,可用于查询

参数seconds:验证码的有效期,单位秒

参数length:验证码的长度,比如常用的4位或6位

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

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

注:目前两条验证码短信获取的间隔时间是60秒,如需取消间隔时间或重新设置您需要修改sdk中的index.js文件,如下图:

6.校验验证码

此方法validateCode需要和方法sendCode配合使用,用于校验用户提交上来的验证码和系统生成的是否一致

wx.cloud.callFunction({
      name: 'zhenzisms',
      data: {
        $url: 'validateCode',
        apiUrl: 'https://sms_developer.zhenzikj.com',
        number: '18511111111',
        code: '6313'
      }
    }).then((res) => {
      console.log(res.result.msg);
    }).catch((e) => {
      console.log(e);
    });

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

参数$url:方法名称,固定不变的

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

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

返回结果是json对象,其中code项是错误代码,msg项是错误描述。code说明 success: 校验成功,empty:未调用sendCode方法生成验证码, code_expired:验证码已过期,过期时间是通过sendCode方法的参数seconds控制,code_error:验证码错误,number_error:手机号错误

7.查看余额

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

wx.cloud.callFunction({
      name: 'zhenzisms',
      data: {
        $url: 'balance',
        apiUrl: 'https://sms_developer.zhenzikj.com'
      }
    }).then((res) => {
      console.log(res.result.body);
    }).catch((e) => {
      //console.log(e);
    });

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

错误代码表

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

8.查询短信

接口描述

根据messageId查询已发送短信

wx.cloud.callFunction({
      name: 'zhenzisms',
      data: {
        $url: 'findSmsByMessageId',
        apiUrl: 'https://sms_developer.zhenzikj.com',
        messageId: 'aaabbb'
      }
    }).then((res) => {
      console.log(res.result.body);
    }).catch((e) => {
      //console.log(e);
    });

请求参数

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

返回结果

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

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

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

短信验证码接口平台 Copyright ©北京榛子科技有限公司
地址: 北京市海淀区上地中关村软件园1期23号楼二层 TEL:185 1846 3823 QQ: 1965891378
站点地图 公司主营:短信验证码 短信接口 短信平台