微信小程序发送验证码短信SDK及文档
微信小程序驗證碼版SDK增加了對短信驗證碼的管理,開發(fā)者無需生成管理驗證碼,該SDK可直接生成、存儲、發(fā)送、校驗。
官網(wǎng)
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為請求地址,個人開發(fā)者使用https://sms_developer.zhenzikj.com,企業(yè)開發(fā)者使用https://sms.zhenzikj.com
1)發(fā)送短信驗證碼
zhenzisms.client.sendCode(function(res){console.log(res.data);})}, number, '驗證碼為:{code}', messageId, seconds, length);send方法用于單條發(fā)送短信
參數(shù)1:請求后的用于接收返回結(jié)果的回調(diào)函數(shù)
參數(shù)number:接收者手機號碼
參數(shù)3:短信模板,其中{code}為驗證碼占位符,會自動替換
參數(shù)messageId:該條信息的唯一標識,可用于查詢
參數(shù)seconds:驗證碼有效期,單位是秒
參數(shù)length:驗證碼長度,比如4位或6位
返回結(jié)果是json格式的字符串, code: 發(fā)送狀態(tài),0為成功。非0為發(fā)送失敗,可從data中查看錯誤信息
注: 測試發(fā)送短信內(nèi)容不要使用"你好"或"12132"全數(shù)字形式,這種短信內(nèi)容沒有具體的意義,可能會被運營商屏蔽
2)校驗驗證碼
檢驗用戶輸入的驗證碼是否和發(fā)送的一致
var result = zhenzisms.client.validateCode(code);參數(shù)code:用戶輸入的驗證碼
返回結(jié)果是字符串, ok: 校驗成功,error:驗證碼錯誤, expired: 驗證碼過期
3)發(fā)送短信
zhenzisms.client.send(function(res){console.log(res.data);})}, '15811111111', '您的驗證碼為2323');send方法用于單條發(fā)送短信
參數(shù)1:請求后的用于接收返回結(jié)果的回調(diào)函數(shù),參數(shù)2:接收者手機號碼,參數(shù)3:短信內(nèi)容
返回結(jié)果是json格式的字符串, code: 發(fā)送狀態(tài),0為成功。非0為發(fā)送失敗,可從data中查看錯誤信息
注: 測試發(fā)送短信內(nèi)容不要使用"你好"或"12132"全數(shù)字形式,這種短信內(nèi)容沒有具體的意義,可能會被運營商屏蔽
{"code":0,"data":"發(fā)送成功"}4)發(fā)送短信(返回狀態(tài)報告)
zhenzisms.client.send(function(res){console.log(res.data);})}, '15811111111', '您的驗證碼為2323', 'dfee_dfdw_xdfd_dfdfd');send方法用于單條發(fā)送短信,并且開發(fā)者可接受短信發(fā)送狀態(tài)報告,具體使用請參考:API說明
參數(shù)1:請求后的用于接收返回結(jié)果的回調(diào)函數(shù),參數(shù)2:接收者手機號碼,參數(shù)3:短信內(nèi)容, 參數(shù)4:messageId即該條短信的唯一標識, 不能重復
返回結(jié)果是json格式的字符串, code: 發(fā)送狀態(tài),0為成功。非0為發(fā)送失敗,可從data中查看錯誤信息
錯誤代碼表
| 100 | 參數(shù)格式錯誤 | 檢查請求參數(shù)是否為空, 或手機號碼格式錯誤 |
| 101 | 短信內(nèi)容超過1000字 | 短信內(nèi)容過長,請篩檢或分多次發(fā)送 |
| 105 | appId錯誤或應用不存在 | 請聯(lián)系工作人員申請應用或檢查appId是否輸入錯誤 |
| 106 | 應用被禁止 | 請聯(lián)系工作人員查看原因 |
| 107 | ip錯誤 | 如果設置了ip白名單,系統(tǒng)會檢查請求服務器的ip地址,已確定是否為安全的來源訪問 |
| 108 | 短信余額不足 | 需要到用戶中心進行充值 |
| 109 | 今日發(fā)送超過限額 | 如果設置了日發(fā)送數(shù)量,則每個接收號碼不得超過這個數(shù)量 |
| 110 | 應用秘鑰(AppSecret)錯誤 | 檢查AppSecret是否輸入錯誤,或是否已在用戶中心進行了秘鑰重置 |
| 111 | 賬號不存在 | 請聯(lián)系工作人員申請賬號 |
| 1000 | 系統(tǒng)位置錯誤 | 請聯(lián)系工作人員或技術人員檢查原因 |
5)查看余額
通過該接口可查看當前剩余的短信條數(shù)
zhenzisms.client.balance(function(res){console.log(res.data)});返回結(jié)果是json格式的字符串, code: 查詢狀態(tài),0為成功,data為剩余短信條數(shù)。非0為查詢失敗,可從data中查看錯誤信息
錯誤代碼表
| 100 | 參數(shù)格式錯誤 | 檢查請求參數(shù)是否為空 |
| 105 | appId錯誤或應用不存在 | 請聯(lián)系工作人員申請應用或檢查appId是否輸入錯誤 |
| 106 | 應用被禁止 | 請聯(lián)系工作人員查看原因 |
| 107 | ip錯誤 | 如果設置了ip白名單,系統(tǒng)會檢查請求服務器的ip地址,已確定是否為安全的來源訪問 |
| 110 | 應用秘鑰(AppSecret)錯誤 | 檢查AppSecret是否輸入錯誤,或是否已在用戶中心進行了秘鑰重置 |
| 1000 | 系統(tǒng)位置錯誤 | 請聯(lián)系工作人員或技術人員檢查原因 |
6)查詢短信
接口描述
根據(jù)messageId查詢已發(fā)送短信
zhenzisms.client.findSmsByMessageId(function(res){console.log(res.data)}, 'dfee_dfdw_xdfd_dfdfd');請求參數(shù)
| messageId | 是 | string | 信息id,對應發(fā)送短信接口的messageId字段 |
返回結(jié)果
返回結(jié)果是json格式的字符串, code: 查詢狀態(tài),0為成功。非0為失敗,可從data中查看錯誤信息
{"code":0,"data":{}}返回結(jié)果是json格式的字符串, code: 查詢狀態(tài),0為成功,data短信信息的json字符串
?
原文:?http://www.see-source.com/blog/300000108/10574.html
?
總結(jié)
以上是生活随笔為你收集整理的微信小程序发送验证码短信SDK及文档的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 使用librtmp接收数据时要注意的问题
- 下一篇: jcr多久更新一次_2020年期刊影响因