SUBMAIL赛邮云通信短信接口调用教程,一分钟集成
创建账户
在进行短信接口调用前,请在官网https://www.mysubmail.com/先完成您的账户创建并登陆(企业用户需要上传有效的营业执照扫描件,机构/政府企事业单位请上传有效的组织机构代码证扫描件;个人开发者需要上传个人身份证正反面,并附上一张手持身份证拍照图片一并上传,同时个人开发者仅限于使用事务类短信,不支持营销类短信。)
创建短信模板
登入短信后台,创建新的短信模板。创建步骤如下:
创建/管理短信项目模板-》创建新模板-》在弹出框内输入模板内容和短信签名,最后点击“提交审核”。审核通过即完成新短信模板的创建。请注意:如您发送的短信带有变量,那么必须创建带有变量的模板,所以短信模板创建有两种,为变量模板和无变量模板。
提醒:创建或更新模板需要人工审核,模板审核时间一般为工作日(周一至周五):上午8:00-凌晨12:00; 法定假期和双休日:上午11:00-凌晨12:00,工作时间一般为1-5分钟以内审核完成。
创建APPID
创建新的APPID 用于短信 WEB API 请求;或更新您的APPID 权限、状态和安全设置。创建步骤如下:
创建/管理APPID-》创建APPID-》在弹出框中输入APPID名称,即完成APPID的创建。
创建地址簿
短信地址簿为短信接受方的手机号集合文件,创建步骤如下:
创建/管理手机地址簿-》新建地址簿-》输入地址簿名称-》导入联系人-》创建完成。但是请注意,在导入联系人时有两种,分别是直接输入和从文件导入。
调用接口
1、前往-》开发者 -》SDK开发包下载页面,下载对应语言的SDK开发包。(本文将以世界上最好的语言php为例)。
SUBMAIL 提供多达9种语言的开发包,SDK集成了 SUBMAIL 的API请求方法,并将API中的参数进行封装,开发者仅需下载对应语言的开发包即可快速配置短信服务。详情如下图所示:
2、将已创建的应用ID和应用密钥复制到开发包的配置文件内
以PHP SDK为例,请将APPID和应用密钥复制到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
复制/粘贴后保存该配置文件,进行下一步;
3、本文以 PHP 开发包为例,其他语言可作为参考,具体文件和目录可能略有不同
(1)打开下载的开发包中 DEMO 目录下message_xsend_demo.php 文件;
(2)将短信-》项目中需要发送的模板的项目ID复制到 $submail->SetProject('xxxxx')方法中,替换'xxxxx'部分;
(3)使用$submail->AddVar()方法,替换模板中yhdsw的@var(code) 变量。addvar方法有2个必选参数,第一个参数为变量名(本实例中即 code),第二个参数为该变量的值,例如:$submail->AddVar('code','198277'); 即将短信模板中 @var(code) 变量,替换为'198277'。addVar 方法可多次调用;
(4)在$submail->setTo('15*********');参数中填写接收者的手机号码;
完整的代码如下图所示:
保存该demo文件,运行即可发送该短信。
以上代码输出的短信为:您的验证码:198277,请在30分钟内输入,如非本人操作请忽略。【SUBMAIL】赛邮云通信