Overview

目前腾讯云短信为客户提供国内短信，国际短信，语音通知三大服务。

国内短信提供单发，群发，带模板ID单发，带模板ID群发以及短信回执与回复拉取。

国际短信可以直接使用国内单发接口，只需替换相应的国家码与手机号码。

语音通知目前支持语音验证码以及语音通知功能。

Getting Start

准备

• 申请APPID以及APPKey

在开始本教程之前，您需要先获取APPID和APPkey,如您尚未申请，请到https://console.qcloud.com/sms/smslist 中添加应用。应用添加成功后您将获得APPID以及APPKey,注意APPID是以14xxxxx开头。

• 申请签名

下发短信必须携带签名，在相应服务模块 短信内容配置 中进行申请。

• 申请模板

下发短信内容必须经过审核，在相应服务 短信内容配置 中进行申请。

完成以上三项便可开始代码开发。

安装

qcloudsms可以采用多种方式进行安装，我们提供以下三种方法供用户使用

maven

要使用qcloudsms功能，需要在pom.xml中添加如下依赖

<dependency>
  	<groupId>com.github.qcloudsms</groupId>
  	<artifactId>sms</artifactId>
  	<version>0.9.1</version>
</dependency>

sbt

libraryDependencies += "com.github.qcloudsms" % "sms" % "0.9.1"

其他

• 方法1 将源代码 直接引入到项目工程中。
• 方法2 将JAR包直接引入到您的工程中。

Note: 由于qcloudsms中需要使用以下四个依赖项目 org.json , httpclient, httpcore, httpmine 采用方法1，2都需要将以上四个jar包导入工程。

用法

若您对接口存在疑问，可以查阅API文档

首先导入库

import com.github.qcloudsms.*;

导入qcloudsms库之后可以开始发送短信。

• 单发短信

 try {
        SmsSingleSender sender = new   SmsSingleSender(appid, "replace with key");
	SmsSingleSenderResult result = sender.send(0, "86", "18326693192", "【腾讯】验证码测试1234", "", "123");
	System.out.print(result);
 } catch (Exception e) {
	e.printStackTrace();
 }

Note:如需发送国际短信，同样可以使用此接口，只需将国家码"86"改写成对应国家码号。

• 指定模板ID单发短信

//假设短信模板 id 为 123，模板内容为：测试短信，{1}，{2}，{3}，上学。
 SmsSingleSender sender = new SmsSingleSender(appid,"replace with key");
 ArrayList<String> params = new ArrayList<String>();
 params.add("指定模板单发");
 params.add("深圳");
 params.add("小明");
 SmsSingleSenderResult   result = sender.sendWithParam("86", "18326693192", 123, params, "", "", "");
 System.out.println(result);

Note:无论单发短信还是指定模板ID单发短信都需要从控制台中申请模板并且模板已经审核通过，才可能下发成功，否则返回失败。

• 群发

// 初始化群发
SmsMultiSender multiSender = new SmsMultiSender(appid, "replace with key");
// 普通群发
// 下面是 3 个假设的号码
ArrayList<String> phoneNumbers = new ArrayList<String>();
phoneNumbers.add("13101116651");
phoneNumbers.add("13101116652");
phoneNumbers.add("13101116653");
SmsMultiSenderResult multiSenderResult = multiSender.send(0, "86", phoneNumbers, 
	"【腾讯】测试短信，普通群发，深圳，小明，上学。", "", "");
System.out.println(multiSenderResult);

• 指定模板ID群发

SmsMultiSender multiSender = new SmsMultiSender(appid, "replace with key");
// 下面是 3 个假设的号码
ArrayList<String> phoneNumbers = new ArrayList<String>();
phoneNumbers.add("13101116651");
phoneNumbers.add("13101116652");
phoneNumbers.add("13101116653");
// 假设短信模板 id 为 123，模板内容为：测试短信，{1}，{2}，{3}，上学。
params = new ArrayList<String>();
params.add("指定模板群发");
params.add("深圳");
params.add("小明");
multiSenderResult = multiSender.sendWithParam("86", phoneNumbers, 123, params, "", "", "");
System.out.println(multiSenderResult);

Note:群发一次请求最多支持200个号码，如有对号码数量有特殊需求请联系腾讯云短信技术支持(QQ:3012203387)。

• 发送语音验证码

  //语音验证码发送
  SmsVoiceVerifyCodeSender smsVoiceVerifyCodeSender = new SmsVoiceVerifyCodeSender(appid, "replace with key");
  SmsVoiceVerifyCodeSenderResult smsVoiceVerifyCodeSenderResult = smsVoiceVerifyCodeSender.send("86",
      "1310555552", "123",2,"");
  System.out.println(smsVoiceVerifyCodeSenderResult);

Note:语音验证码发送只需提供验证码数字，例如在msg=“123”,您收到的语音通知为“您的语音验证码是1 2 3”，如需自定义内容，可以使用语音通知

• 发送语音通知

   SmsVoicePromptSender smsVoicePromtSender = new SmsVoicePromptSender(appid, "replace with key");
   SmsVoicePromptSenderResult smsSingleVoiceSenderResult = smsVoicePromtSender.send("86", "13758028086", 2,2,
     "欢迎使用XXX，本次活动xxx", "");
   System.out.println(smsSingleVoiceSenderResult);

• 拉取短信回执以及回复

   SmsStatusPuller pullstatus = new SmsStatusPuller(appid, "replace with key");
   SmsStatusPullCallbackResult callbackResult = pullstatus.pullCallback(10);
   System.out.println(callbackResult);
   SmsStatusPullReplyResult replyResult = pullstatus.pullReply(10);
   System.out.println(replyResult);

Note: 短信拉取功能需要联系腾讯云短信技术支持(QQ:3012203387)，量大客户可以使用此功能批量拉取，其他客户不建议使用。

• 发送国际短信 国际短信参考单发短信