Leo:发表于2015-08-23

一分钟快速集成短信验证码[图文教程]

感谢您选择 SUBMAIL 短信服务,下面这篇教程将指引您快速配置短信API服务。

 

基础知识

在进行以下步骤前,请先完成您的账户配置,并前往-》短信-》短信服务配置页面上传相关资质,确保你的短信服务协议已配置完成(短信服务资质通过审核后,需要您注销当前登录,重新登入一次)。

SUBMAIL 目前提供5个应用,分别为:邮件(MAIL),短信(MESSAGE),地址薄(ADDRESS BOOK),应用集成(DEVELOPER)和账户(ACCOUNT)

各应用提供的功能大致如下:

  • 邮件(MAIL):创建/管理 邮件模板、群发邮件、查看发送报告等功能
  • 短信(MESSAGE):创建/管理 短信模板、设置等
  • 地址薄(ADDRESS BOOK):创建/管理 邮件和短信地址薄功能
  • 应用集成(DEVELOPER):创建/管理 应用ID、查看由API发送的邮件或短信分析报告、历史明细,配置SUBHOOK等
  • 账户(ACCOUNT):用户账户设置、工单、订单管理、通知中心

 

在每个应用页面顶部工具栏“+”号按钮可以切换应用,如下图红色箭头位置所示:

 

 

单击“+”按钮可以展开应用切换菜单,单击“X”按钮关闭该菜单,如下图所示:

 


 

步骤一、前往-》开发者 -》SDK开发包下载页面,下载对应语言的SDK开发包。

SUBMAIL 提供多达9种语言的开发包,SDK 集成了 SUBMAIL 的API请求方法,并将API中的参数进行封装,开发者仅需下载对应语言的开发包即可快速配置短信服务。

如上图所示,点击您当前使用的程序语言,选择对应的开发包下载即可(本文以 PHP 语言为例)。

 


 

步骤二、创建应用获取 API 请求的应用ID和密钥(APPID 和 APPKEY)

 

SUBMAIL的API请求需要应用ID和密钥用于 API 身份鉴权,创建应用的步骤如下:

1. 前往-》应用集成-》应用页面进行创建,如下图所示:

 

 

2.  将已创建的应用ID和应用密钥复制到开发包的配置文件内

以 PHP SDK为例,请将应用页面的应用ID和应用密钥复制到 app_config.php 文件内的对应位置,如下图:

各语言的配置文件对应清单:

  • PHP => /path/to/app_config.php
  • JAVA => /path/to/app_config.properties
  • C# => /path/to/AppConfigs.cs
  • PYTHON => /path/to/app_configs.py
  • RUBY =>  /path/to/submaildemo.rb
  • GO => /path/to/main.go
  • OBJECTIVE-C => /path/to/config/SMConfig.h
  • SWIFT =>  /path/to/config/Config.swift
  • Node.js => /path/to/config.js

复制/粘贴后保存该配置文件,进行下一步;

 


 

步骤三、创建短信模板

 

前往-》短信-》新建 页面可以创建新的短信模板,如图所示:

 

  1. 在新建页面创建短信模板,输入短信内容和签名,动态内容(如验证码)请使用文本变量代替。请参阅文本变量文档
  2. 模板输入完成后,点击提交审核按钮,后台工程师将对此模板进行快速审核(模板审核时间为早8:00 至 晚12:00,审核时间一般为2-5分钟左右)
  3. 等待模板审核通过后即可进入 短信-》项目 页面,点击该模板工具栏中的应用集成“粉红色”按钮,获取该模板的项目标识,请参阅获取项目标识文档
  4. 您可以在新建页面创建多个模板,如验证码,订单通知,发货通知,各种提醒等。

 


 

步骤四、SDK 接口调用

 

本文以 PHP 开发包为例,其他语言可作为参考,具体文件和目录可能略有不同

  1. 打开下载的开发包中 DEMO 目录下的 message_xsend_demo.php 文件;
  2. 将短信-》项目中需要发送的模板的项目ID复制到 $submail->SetProject('xxxxx')方法中,替换'xxxxx'部分;
  3. 使用$submail->AddVar()方法,替换模板中申明的@var(code) 变量。addvar方法有2个必选参数,第一个参数为变量名(本实例中即 code),第二个参数为该变量的值,例如:$submail->AddVar('code','198277');  即将短信模板中 @var(code) 变量,替换为'198277'。addVar 方法可多次调用;
  4. $submail->setTo('15*********');参数中填写接收者的手机号码;

 

完整的代码如图所示:

保存该demo文件,运行即可发送该短信。

以上代码输出的短信为:您的验证码:198277,请在30分钟内输入,如非本人操作请忽略。【SUBMAIL】


 

© 2014 SUBMAIL All Rights reserved. 保留所有权利

沪ICP备16035411号-1