微信小程序發送驗證碼短信SDK及文檔

微信小程序驗證碼版SDK增加了對短信驗證碼的管理,開發者無需生成管理驗證碼,該SDK可直接生成、存儲、發送、校驗。

官網

SDK下載地址

demo

 

1.安裝
下載後的SDK只包含一個zhenzisms.js文件,可直接放在utils文件夾中,然後通過require引入,如下:

var zhenzisms = require('../../utils/zhenzisms.js');
2.配置域名
在微信公衆平臺-小程序管理中配置域名https://smsdeveloper.zhenzikj.com,如下圖:

3.用法
使用事先申請的AppId、AppSecret初始化:

zhenzisms.client.init(apiUrl, appId, appSecret);
apiUrl爲請求地址,個人開發者使用https://sms_developer.zhenzikj.com,企業開發者使用https://sms.zhenzikj.com

1)發送短信驗證碼
zhenzisms.client.sendCode(function(res){
console.log(res.data);
})
}, number, '驗證碼爲:{code}', messageId, seconds, length);
send方法用於單條發送短信

參數1:請求後的用於接收返回結果的回調函數

參數number:接收者手機號碼

參數3:短信模板,其中{code}爲驗證碼佔位符,會自動替換

參數messageId:該條信息的唯一標識,可用於查詢

參數seconds:驗證碼有效期,單位是秒

參數length:驗證碼長度,比如4位或6位

返回結果是json格式的字符串, code: 發送狀態,0爲成功。非0爲發送失敗,可從data中查看錯誤信息

注: 測試發送短信內容不要使用"你好"或"12132"全數字形式,這種短信內容沒有具體的意義,可能會被運營商屏蔽

2)校驗驗證碼
檢驗用戶輸入的驗證碼是否和發送的一致

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

參數code:用戶輸入的驗證碼

返回結果是字符串, ok: 校驗成功,error:驗證碼錯誤, expired: 驗證碼過期

3)發送短信
zhenzisms.client.send(function(res){
console.log(res.data);
})
}, '15811111111', '您的驗證碼爲2323');
send方法用於單條發送短信

參數1:請求後的用於接收返回結果的回調函數,參數2:接收者手機號碼,參數3:短信內容

返回結果是json格式的字符串, code: 發送狀態,0爲成功。非0爲發送失敗,可從data中查看錯誤信息

注: 測試發送短信內容不要使用"你好"或"12132"全數字形式,這種短信內容沒有具體的意義,可能會被運營商屏蔽

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

4)發送短信(返回狀態報告)
zhenzisms.client.send(function(res){
console.log(res.data);
})
}, '15811111111', '您的驗證碼爲2323', 'dfee_dfdw_xdfd_dfdfd');
send方法用於單條發送短信,並且開發者可接受短信發送狀態報告,具體使用請參考:API說明

參數1:請求後的用於接收返回結果的回調函數,參數2:接收者手機號碼,參數3:短信內容, 參數4:messageId即該條短信的唯一標識, 不能重複

返回結果是json格式的字符串, code: 發送狀態,0爲成功。非0爲發送失敗,可從data中查看錯誤信息

錯誤代碼表
錯誤碼 原因 解決方案
100 參數格式錯誤 檢查請求參數是否爲空, 或手機號碼格式錯誤
101 短信內容超過1000字 短信內容過長,請篩檢或分多次發送
105 appId錯誤或應用不存在 請聯繫工作人員申請應用或檢查appId是否輸入錯誤
106 應用被禁止 請聯繫工作人員查看原因
107 ip錯誤 如果設置了ip白名單,系統會檢查請求服務器的ip地址,已確定是否爲安全的來源訪問
108 短信餘額不足 需要到用戶中心進行充值
109 今日發送超過限額 如果設置了日發送數量,則每個接收號碼不得超過這個數量
110 應用祕鑰(AppSecret)錯誤 檢查AppSecret是否輸入錯誤,或是否已在用戶中心進行了祕鑰重置
111 賬號不存在 請聯繫工作人員申請賬號
1000 系統位置錯誤 請聯繫工作人員或技術人員檢查原因
5)查看餘額
通過該接口可查看當前剩餘的短信條數

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 系統位置錯誤 請聯繫工作人員或技術人員檢查原因
6)查詢短信
接口描述
根據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字符串

 

原文: http://smsow.zhenzikj.com/news/detail/299.html

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章