smsVerification

来自于:官方立即使用

sendMessage

概述

smsVerification 模块封装了云之讯短信验证接口,使用此模块可快速集成云之讯短信功能到自己的 APP。在使用之前需要先到云之讯开发者平台申请注册开发者账号,短信接入的流程如下图所示:

图片说明

详情参考 云之讯短信验证接入指南

本模块封装了上述步骤中的对接接口的过程。

模块接口

sendMessage

请求云之讯服务器,发送验证码到用户客户端

sendMessage({params},callback())

params

softVersion:

  • 类型:字符串
  • 描述:云之讯REST API版本号

accountSid

  • 类型:字符串
  • 描述:账户Id,注册云之讯官网,在控制台中即可获取此参数

accountToken

  • 类型:字符串
  • 描述:账户授权令牌,注册云之讯官网,在控制台中即可获取此参数

body:

  • 类型:JSON 对象
  • 描述:发送短信参数配置
  • 内部字段:
  1. {
  2. appId: '', //字符串类型;应用ID
  3. templateId: '', //字符串类型;短信模板id,短信模板需要到控制台创建,创建完成后就可以获得该值
  4. phoneNumber: '', //字符串类型;需要下发短信的手机号码,支持国际号码,需要加国家码
  5. param: '' //字符串类型;模板中的替换参数,如果有多个参数则需要写在同一个字符串中,以逗号分隔. (如:param=“a,b,c”)
  6. }

callback

ret:

  • 类型:JSON对象
  • 描述:返回值
  1. {
  2. "respCode" : "000000",
  3. "failure" : 1,
  4. "templateSMS" : {
  5. "createDate" : 20140623185016,
  6. "smsId" : "f96f79240e372587e9284cd580d8f953"
  7. }
  8. }

示例代码

  1. var smsVerification = api.require('smsVerification');
  2. smsVerification.sendMessage({
  3. softVersion : '2014-06-30',
  4. accountSid : 'e03bc9106c6ed0eaebfce8c368fdcd48',
  5. accountToken: '',
  6. body: {
  7. appId : 'e462aba25bc6498fa5ada7eefe1401b7',
  8. templateId : 1,
  9. phoneNumber : '15301058162',
  10. param :'100'
  11. }
  12. }, function(ret){
  13. alert(JSON.stringify(ret));
  14. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本