Node.js SDK 开发文档

1.安装

下载后的SDK只包含一个zhenzisms.js文件，直接导入到工程中即可使用。

2.用法

引入模块

const zhenzismsClient = require('./zhenzisms');

zhenzisms.js的具体引入地址请根据您的实际路径替换

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

appId、appSecret的获取请参考准备

var client = new ZhenzismsClient(apiUrl, '您的榛子云appId', '您的榛子云appSecret');

apiUrl为请求地址，个人开发者使用sms_developer.zhenzikj.com，企业开发者使用sms.zhenzikj.com, 注意不要带有协议前缀http或https

AppId、AppSecret为榛子云短信的开发参数，可通过注册获取

1)发送短信

var params = {}; params.templateId = '13'; params.number = '18511111111'; params.templateParams = ["2222", "5分钟"]; var res = client.send(params);

send方法用于单条发送短信, 参数以json对象形式

返回结果是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 res = client.balance();

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

错误代码表

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

3)查询短信

接口描述

根据messageId查询已发送短信

var res = client.findSmsByMessageId(messageId);
res.then(function(res) {
    console.log(res);
 });

注: messageId参数为send接口发送短信设置的

请求参数

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

返回结果

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

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

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