tencent cloud

文档反馈

Java SDK

最后更新时间:2024-06-27 15:48:01
    SDK 3.0是云 API 3.0平台的配套工具,您可以通过 SDK 使用所有 短信 API。新版 SDK 实现了统一化,具有各个语言版本的 SDK 使用方法相同,接口调用方式相同,错误码相同以及返回包格式相同等优点。
    注意:
    接入国际站要求的接口版本。
    接入国际站需要使用短信 API 2021-01-11 版本,可参考示例代码。
    发送短信相关接口。
    一次群发请求最多支持200个号码。
    签名、正文模板相关接口。
    个人认证用户不支持使用签名、正文模板相关接口,只能通过短信控制台 管理短信签名管理短信正文模板。如需使用该类接口,请将 “个人认证” 变更为 “企业认证”。

    前提条件

    了解 地域 概念,选择需求的地域接入。
    已开通短信服务,具体操作请参见 国际/港澳台短信快速入门
    已在访问管理控制台 > API 密钥管理 页面获取 SecretID 和 SecretKey。
    SecretID 用于标识 API 调用者的身份。
    SecretKey 用于加密签名字符串和服务器端验证签名字符串的密钥,SecretKey 需妥善保管,避免泄露
    短信的调用地址为sms.tencentcloudapi.com

    相关资料

    各个接口及其参数的详细介绍请参见 API 文档
    下载 SDK 源码请访问 Github 仓库 或者 Gitee 仓库

    安装 SDK

    通过 Maven 安装(推荐)

    Github 仓库参见: 通过 Maven 安装(推荐)
    Gitee 仓库参见: 通过 Maven 安装(推荐)

    通过源码包安装

    Github 仓库参见: 通过源码包安装
    Gitee 仓库参见: 通过源码包安装

    示例代码

    说明:
    所有示例代码仅作参考,无法直接编译和运行,需根据实际情况进行修改,您也可以根据实际需求使用 API 3.0 Explorer 自动化生成 Demo 代码。
    每个接口都有一个对应的 Request 结构和一个 Response 结构。本文仅列举几个常用功能的示例代码,如下所示。

    发送短信

    import com.tencentcloudapi.common.Credential;
    import com.tencentcloudapi.common.exception.TencentCloudSDKException;
    
    //导入可选配置类
    import com.tencentcloudapi.common.profile.ClientProfile;
    import com.tencentcloudapi.common.profile.HttpProfile;
    
    // 导入对应SMS模块的client
    import com.tencentcloudapi.sms.v20210111.SmsClient;
    
    // 导入要请求接口对应的request response类
    import com.tencentcloudapi.sms.v20210111.models.SendSmsRequest;
    import com.tencentcloudapi.sms.v20210111.models.SendSmsResponse;
    
    /**
    * Tencent Cloud Sms Sendsms
    *
    */
    public class SendSms
    {
    public static void main(String[] args)
    {
    try {
    // 实例化一个认证对象,入参需要传入腾讯云账户 SecretId,SecretKey。 // 为了保护密钥安全,建议将密钥设置在环境变量中或者配置文件中,请参考凭证管理 https://github.com/TencentCloud/tencentcloud-sdk-java?tab=readme-ov-file#%E5%87%AD%E8%AF%81%E7%AE%A1%E7%90%86。 // 硬编码密钥到代码中有可能随代码泄露而暴露,有安全隐患,并不推荐。
    // SecretId、SecretKey 查询: https://console.tencentcloud.com/cam/capi // Credential cred = new Credential("SecretId", "SecretKey"); Credential cred = new Credential(System.getenv("TENCENTCLOUD_SECRET_ID"), System.getenv("TENCENTCLOUD_SECRET_KEY"));
    // 实例化一个http选项,可选的,没有特殊需求可以跳过 HttpProfile httpProfile = new HttpProfile(); // 从3.0.96版本开始, 单独设置 HTTP 代理(无需要直接忽略) // httpProfile.setProxyHost("真实代理ip"); // httpProfile.setProxyPort(真实代理端口); httpProfile.setReqMethod("GET"); // get请求(默认为post请求) httpProfile.setConnTimeout(10); // 请求连接超时时间,单位为秒(默认60秒) httpProfile.setWriteTimeout(10); // 设置写入超时时间,单位为秒(默认0秒) httpProfile.setReadTimeout(10); // 设置读取超时时间,单位为秒(默认0秒)
    /* 指定接入地域域名,默认就近地域接入域名为 sms.tencentcloudapi.com ,也支持指定地域域名访问,例如新加坡地域的域名为 sms.ap-singapore.tencentcloudapi.com */
    httpProfile.setEndpoint("sms.tencentcloudapi.com");
    
    /* 非必要步骤:
    * 实例化一个客户端配置对象,可以指定超时时间等配置 */
    ClientProfile clientProfile = new ClientProfile();
    /* SDK默认用TC3-HMAC-SHA256进行签名
    * 非必要请不要修改这个字段 */
    clientProfile.setSignMethod("HmacSHA256");
    clientProfile.setHttpProfile(httpProfile);
    /* 实例化要请求产品(以sms为例)的client对象
    * 第二个参数是地域信息,根据您选择的国际站地域,如您选择的是新加坡国际站,则应该填入字符串ap-singapore,地域列表可参考 https://www.tencentcloud.com/document/api/382/40466?lang=en#region-list */
    SmsClient client = new SmsClient(cred, "ap-singapore",clientProfile);
    /* 实例化一个请求对象,根据调用的接口和实际情况,可以进一步设置请求参数
    * 你可以直接查询SDK源码确定接口有哪些属性可以设置
    * 属性可能是基本类型,也可能引用了另一个数据结构
    * 推荐使用IDE进行开发,可以方便的跳转查阅各个接口和数据结构的文档说明 */
    SendSmsRequest req = new SendSmsRequest();
    
    /* 填充请求参数,这里request对象的成员变量即对应接口的入参
    * 你可以通过官网接口文档或跳转到request对象的定义处查看请求参数的定义
    * 基本类型的设置:
    * 帮助链接:
    * 短信控制台: https://console.tencentcloud.com/smsv2
    * sms helper: https://www.tencentcloud.com/document/product/382/3773 */
    
    /* 短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId,示例如2400006666 */
    String sdkAppId = "2400006666";
    req.setSmsSdkAppId(sdkAppId);
    
    /* 短信签名内容: 使用 UTF-8 编码,必须填写已审核通过的签名,签名信息可登录 [短信控制台] 查看 */
    String signName = "签名内容";
    req.setSignName(signName);
    
    /* 国际/港澳台短信 SenderId: 中国大陆地区短信填空,默认未开通,如需开通请联系 [sms helper] */
    String senderid = "";
    req.setSenderId(senderid);
    
    /* 用户的 session 内容: 可以携带用户侧 ID 等上下文信息,server 会原样返回 */
    String sessionContext = "xxx";
    req.setSessionContext(sessionContext);
    
    /* 短信号码扩展号: 默认未开通,如需开通请联系 [sms helper] */
    String extendCode = "";
    req.setExtendCode(extendCode);
    
    /* 模板 ID: 必须填写已审核通过的模板 ID。模板ID可登录 [短信控制台] 查看 */
    String templateId = "400000";
    req.setTemplateId(templateId);
    
    /* 下发手机号码,采用 E.164 标准,+[国家或地区码][手机号]
    * 示例如:+60198890000, 其中前面有一个+号 ,60为国家码,198890000为手机号,最多不要超过200个手机号 */
    String[] phoneNumberSet = {"+60198890000", "+60198890001", "+60198890002"};
    req.setPhoneNumberSet(phoneNumberSet);
    
    /* 模板参数: 若无模板参数,则设置为空 */
    String[] templateParamSet = {"5678"};
    req.setTemplateParamSet(templateParamSet);
    
    /* 通过 client 对象调用 SendSms 方法发起请求。注意请求方法名与请求对象是对应的
    * 返回的 res 是一个 SendSmsResponse 类的实例,与请求对象对应 */
    SendSmsResponse res = client.SendSms(req);
    
    // 输出json格式的字符串回包
    System.out.println(SendSmsResponse.toJsonString(res));
    
    // 也可以取出单个值,你可以通过官网接口文档或跳转到response对象的定义处查看返回字段的定义
    System.out.println(res.getRequestId());
    
    } catch (TencentCloudSDKException e) {
    e.printStackTrace();
    }
    }
    }

    拉取回执状态

    import com.tencentcloudapi.common.Credential;
    import com.tencentcloudapi.common.exception.TencentCloudSDKException;
    
    //导入可选配置类
    import com.tencentcloudapi.common.profile.ClientProfile;
    import com.tencentcloudapi.common.profile.HttpProfile;
    
    // 导入对应SMS模块的client
    import com.tencentcloudapi.sms.v20210111.SmsClient;
    
    // 导入要请求接口对应的request response类
    import com.tencentcloudapi.sms.v20210111.models.PullSmsReplyStatusRequest;
    import com.tencentcloudapi.sms.v20210111.models.PullSmsReplyStatusResponse;
    
    /**
    * Tencent Cloud Sms PullSmsSendStatus
    *
    */
    public class PullSmsSendStatus {
    public static void main(String[] args) {
    try {
    // 实例化一个认证对象,入参需要传入腾讯云账户 SecretId,SecretKey。 // 为了保护密钥安全,建议将密钥设置在环境变量中或者配置文件中,请参考凭证管理 https://github.com/TencentCloud/tencentcloud-sdk-java?tab=readme-ov-file#%E5%87%AD%E8%AF%81%E7%AE%A1%E7%90%86。 // 硬编码密钥到代码中有可能随代码泄露而暴露,有安全隐患,并不推荐。
    // SecretId、SecretKey 查询: https://console.tencentcloud.com/cam/capi // Credential cred = new Credential("SecretId", "SecretKey"); Credential cred = new Credential(System.getenv("TENCENTCLOUD_SECRET_ID"), System.getenv("TENCENTCLOUD_SECRET_KEY"));
    // 实例化一个http选项,可选的,没有特殊需求可以跳过 HttpProfile httpProfile = new HttpProfile(); // 从3.0.96版本开始, 单独设置 HTTP 代理(无需要直接忽略) // httpProfile.setProxyHost("真实代理ip"); // httpProfile.setProxyPort(真实代理端口); httpProfile.setReqMethod("GET"); // get请求(默认为post请求) httpProfile.setConnTimeout(30); // 请求连接超时时间,单位为秒(默认60秒) httpProfile.setWriteTimeout(30); // 设置写入超时时间,单位为秒(默认0秒) httpProfile.setReadTimeout(30); // 设置读取超时时间,单位为秒(默认0秒)
    /* 指定接入地域域名,默认就近地域接入域名为 sms.tencentcloudapi.com ,也支持指定地域域名访问,例如新加坡地域的域名为 sms.ap-singapore.tencentcloudapi.com */
    httpProfile.setEndpoint("sms.tencentcloudapi.com");
    
    /* 非必要步骤:
    * 实例化一个客户端配置对象,可以指定超时时间等配置 */
    ClientProfile clientProfile = new ClientProfile();
    /* SDK默认用TC3-HMAC-SHA256进行签名
    * 非必要请不要修改这个字段 */
    clientProfile.setSignMethod("HmacSHA256");
    clientProfile.setHttpProfile(httpProfile);
    
    /* 实例化要请求产品(以sms为例)的client对象
    * 第二个参数是地域信息,根据您选择的国际站地域,如您选择的是新加坡国际站,则应该填入字符串ap-singapore,地域列表可参考 https://www.tencentcloud.com/document/api/382/40466?lang=en#region-list */
    SmsClient client = new SmsClient(cred, "ap-singapore", clientProfile);
    
    /* 实例化一个请求对象,根据调用的接口和实际情况,可以进一步设置请求参数
    * 你可以直接查询SDK源码确定接口有哪些属性可以设置
    * 属性可能是基本类型,也可能引用了另一个数据结构
    * 推荐使用IDE进行开发,可以方便的跳转查阅各个接口和数据结构的文档说明 */
    PullSmsSendStatusRequest req = new PullSmsSendStatusRequest();
    
    /* 填充请求参数,这里request对象的成员变量即对应接口的入参
    * 你可以通过官网接口文档或跳转到request对象的定义处查看请求参数的定义
    * 基本类型的设置:
    * 帮助链接:
    * 短信控制台: https://console.tencentcloud.com/smsv2
    * sms helper: https://www.tencentcloud.com/document/product/382/3773 */
    
    /* 短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId,示例如2400006666 */
    String sdkAppId = "2400006666";
    req.setSmsSdkAppId(sdkAppId);
    
    // 设置拉取最大条数,最多100条
    Long limit = 5L;
    req.setLimit(limit);
    
    /* 通过 client 对象调用 PullSmsSendStatus 方法发起请求。注意请求方法名与请求对象是对应的
    * 返回的 res 是一个 PullSmsSendStatusResponse 类的实例,与请求对象对应 */
    PullSmsSendStatusResponse res = client.PullSmsSendStatus(req);
    
    // 输出json格式的字符串回包
    System.out.println(PullSmsSendStatusResponse.toJsonString(res));
    
    } catch (TencentCloudSDKException e) {
    e.printStackTrace();
    }
    }
    }

    统计短信发送数据

    import com.tencentcloudapi.common.Credential;
    import com.tencentcloudapi.common.exception.TencentCloudSDKException;
    
    //导入可选配置类
    import com.tencentcloudapi.common.profile.ClientProfile;
    import com.tencentcloudapi.common.profile.HttpProfile;
    
    // 导入对应SMS模块的client
    import com.tencentcloudapi.sms.v20210111.SmsClient;
    
    // 导入要请求接口对应的request response类
    import com.tencentcloudapi.sms.v20210111.models.SendStatusStatisticsRequest;
    import com.tencentcloudapi.sms.v20210111.models.SendStatusStatisticsResponse;
    
    /**
    * Tencent Cloud Sms SendStatusStatistics
    *
    */
    public class SendStatusStatistics {
    public static void main(String[] args) {
    try {
    // 实例化一个认证对象,入参需要传入腾讯云账户 SecretId,SecretKey。 // 为了保护密钥安全,建议将密钥设置在环境变量中或者配置文件中,请参考凭证管理 https://github.com/TencentCloud/tencentcloud-sdk-java?tab=readme-ov-file#%E5%87%AD%E8%AF%81%E7%AE%A1%E7%90%86。 // 硬编码密钥到代码中有可能随代码泄露而暴露,有安全隐患,并不推荐。
    // SecretId、SecretKey 查询: https://console.tencentcloud.com/cam/capi // Credential cred = new Credential("SecretId", "SecretKey"); Credential cred = new Credential(System.getenv("TENCENTCLOUD_SECRET_ID"), System.getenv("TENCENTCLOUD_SECRET_KEY"));
    // 实例化一个http选项,可选的,没有特殊需求可以跳过 HttpProfile httpProfile = new HttpProfile(); // 从3.0.96版本开始, 单独设置 HTTP 代理(无需要直接忽略) // httpProfile.setProxyHost("真实代理ip"); // httpProfile.setProxyPort(真实代理端口); httpProfile.setReqMethod("GET"); // get请求(默认为post请求) httpProfile.setConnTimeout(30); // 请求连接超时时间,单位为秒(默认60秒) httpProfile.setWriteTimeout(30); // 设置写入超时时间,单位为秒(默认0秒) httpProfile.setReadTimeout(30); // 设置读取超时时间,单位为秒(默认0秒)
    /* 指定接入地域域名,默认就近地域接入域名为 sms.tencentcloudapi.com ,也支持指定地域域名访问,例如新加坡地域的域名为 sms.ap-singapore.tencentcloudapi.com */
    httpProfile.setEndpoint("sms.tencentcloudapi.com");
    
    /* 非必要步骤:
    * 实例化一个客户端配置对象,可以指定超时时间等配置 */
    ClientProfile clientProfile = new ClientProfile();
    /* SDK默认用TC3-HMAC-SHA256进行签名
    * 非必要请不要修改这个字段 */
    clientProfile.setSignMethod("HmacSHA256");
    clientProfile.setHttpProfile(httpProfile);
    
    /* 实例化要请求产品(以sms为例)的client对象
    * 第二个参数是地域信息,根据您选择的国际站地域,如您选择的是新加坡国际站,则应该填入字符串ap-singapore,地域列表可参考 https://www.tencentcloud.com/document/api/382/40466?lang=en#region-list */
    SmsClient client = new SmsClient(cred, "ap-singapore",clientProfile);
    
    /* 实例化一个请求对象,根据调用的接口和实际情况,可以进一步设置请求参数
    * 你可以直接查询SDK源码确定接口有哪些属性可以设置
    * 属性可能是基本类型,也可能引用了另一个数据结构
    * 推荐使用IDE进行开发,可以方便的跳转查阅各个接口和数据结构的文档说明 */
    SendStatusStatisticsRequest req = new SendStatusStatisticsRequest();
    
    /* 填充请求参数,这里request对象的成员变量即对应接口的入参
    * 你可以通过官网接口文档或跳转到request对象的定义处查看请求参数的定义
    * 基本类型的设置:
    * 帮助链接:
    * 短信控制台: https://console.tencentcloud.com/smsv2
    * sms helper: https://www.tencentcloud.com/document/product/382/3773 */
    
    /* 短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId,示例如2400006666 */
    String sdkAppId = "2400006666";
    req.setSmsSdkAppId(sdkAppId);
    
    // 设置拉取最大条数,最多100条
    Long limit = 5L;
    req.setLimit(limit);
    /* 偏移量 注:目前固定设置为0 */
    Long offset = 0L;
    req.setOffset(offset);
    /* 开始时间,yyyymmddhh 需要拉取的起始时间,精确到小时 */
    String beginTime = "2019071100";
    req.setBeginTime(beginTime);
    /* 结束时间,yyyymmddhh 需要拉取的截止时间,精确到小时
    * 注:EndTime 必须大于 beginTime */
    String endTime = "2019071123";
    req.setEndTime(endTime);
    
    /* 通过 client 对象调用 SendStatusStatistics 方法发起请求。注意请求方法名与请求对象是对应的
    * 返回的 res 是一个 SendStatusStatisticsResponse 类的实例,与请求对象对应 */
    SendStatusStatisticsResponse res = client.SendStatusStatistics(req);
    
    // 输出json格式的字符串回包
    System.out.println(SendStatusStatisticsResponse.toJsonString(res));
    
    } catch (TencentCloudSDKException e) {
    e.printStackTrace();
    }
    }
    }

    申请短信模板

    import com.tencentcloudapi.common.Credential;
    import com.tencentcloudapi.common.exception.TencentCloudSDKException;
    //导入可选配置类
    import com.tencentcloudapi.common.profile.ClientProfile;
    import com.tencentcloudapi.common.profile.HttpProfile;
    // 导入 SMS 模块的 client
    import com.tencentcloudapi.sms.v20210111.SmsClient;
    // 导入要请求接口对应的 request response 类
    import com.tencentcloudapi.sms.v20210111.models.AddSmsTemplateRequest;
    import com.tencentcloudapi.sms.v20210111.models.AddSmsTemplateResponse;
    /**
    * Tencent Cloud Sms AddSmsTemplate
    *
    */
    public class AddSmsTemplate
    {
    public static void main( String[] args )
    {
    try {
    // 实例化一个认证对象,入参需要传入腾讯云账户 SecretId,SecretKey。 // 为了保护密钥安全,建议将密钥设置在环境变量中或者配置文件中,请参考凭证管理 https://github.com/TencentCloud/tencentcloud-sdk-java?tab=readme-ov-file#%E5%87%AD%E8%AF%81%E7%AE%A1%E7%90%86。 // 硬编码密钥到代码中有可能随代码泄露而暴露,有安全隐患,并不推荐。
    // SecretId、SecretKey 查询: https://console.tencentcloud.com/cam/capi // Credential cred = new Credential("SecretId", "SecretKey"); Credential cred = new Credential(System.getenv("TENCENTCLOUD_SECRET_ID"), System.getenv("TENCENTCLOUD_SECRET_KEY"));
    // 实例化一个http选项,可选的,没有特殊需求可以跳过 HttpProfile httpProfile = new HttpProfile(); // 从3.0.96版本开始, 单独设置 HTTP 代理(无需要直接忽略) // httpProfile.setProxyHost("真实代理ip"); // httpProfile.setProxyPort(真实代理端口); httpProfile.setReqMethod("GET"); // get请求(默认为post请求) httpProfile.setConnTimeout(30); // 请求连接超时时间,单位为秒(默认60秒) httpProfile.setWriteTimeout(30); // 设置写入超时时间,单位为秒(默认0秒) httpProfile.setReadTimeout(30); // 设置读取超时时间,单位为秒(默认0秒)
    /* 指定接入地域域名,默认就近地域接入域名为 sms.tencentcloudapi.com ,也支持指定地域域名访问,例如新加坡地域的域名为 sms.ap-singapore.tencentcloudapi.com */
    httpProfile.setEndpoint("sms.tencentcloudapi.com");
    /* 非必要步骤:
    * 实例化一个客户端配置对象,可以指定超时时间等配置 */
    ClientProfile clientProfile = new ClientProfile();
    /* SDK 默认使用 TC3-HMAC-SHA256 进行签名
    * 非必要请不要修改该字段 */
    clientProfile.setSignMethod("HmacSHA256");
    clientProfile.setHttpProfile(httpProfile);
    /* 实例化 SMS 的 client 对象
    * 第二个参数是地域信息,根据您选择的国际站地域,如您选择的是新加坡国际站,则应该填入字符串ap-singapore,地域列表可参考 https://www.tencentcloud.com/document/api/382/40466?lang=en#region-list */
    SmsClient client = new SmsClient(cred, "ap-singapore", clientProfile);
    /* 实例化一个请求对象,根据调用的接口和实际情况,可以进一步设置请求参数
    * 您可以直接查询 SDK 源码确定接口有哪些属性可以设置
    * 属性可能是基本类型,也可能引用了另一个数据结构
    * 推荐使用 IDE 进行开发,可以方便地跳转查阅各个接口和数据结构的文档说明 */
    AddSmsTemplateRequest req = new AddSmsTemplateRequest();
    /* 填充请求参数,这里 request 对象的成员变量即对应接口的入参
    * 您可以通过官网接口文档或跳转到 request 对象的定义处查看请求参数的定义
    * 基本类型的设置:
    * 帮助链接:
    * 短信控制台:https://console.tencentcloud.com/smsv2
    * sms helper:https://www.tencentcloud.com/document/product/382/3773 */
    /* 模板名称*/
    String templatename = "腾讯云";
    req.setTemplateName(templatename);
    /* 模板内容 */
    String templatecontent = "{1}为您的登录验证码,请于{2}分钟内填写,如非本人操作,请忽略本短信。";
    req.setTemplateContent(templatecontent);
    /* 短信类型,1表示营销短信,2表示通知短信,3表示验证码短信 */
    long smstype = 3;
    req.setSmsType(smstype);
    /* 是否国际/港澳台短信:0:表示中国大陆地区短信,1:表示国际/港澳台短信。 */
    long international = 0;
    req.setInternational(international);
    /* 模板备注:例如申请原因,使用场景等 */
    String remark = "xxx";
    req.setRemark(remark);
    /* 通过 client 对象调用 AddSmsTemplate 方法发起请求。注意请求方法名与请求对象是对应的
    * 返回的 res 是一个 AddSmsTemplateResponse 类的实例,与请求对象对应 */
    AddSmsTemplateResponse res = client.AddSmsTemplate(req);
    // 输出 JSON 格式的字符串回包
    System.out.println(AddSmsTemplateResponse.toJsonString(res));
    // 可以取出单个值,您可以通过官网接口文档或跳转到 response 对象的定义处查看返回字段的定义
    System.out.println(res.getRequestId());
    } catch (TencentCloudSDKException e) {
    e.printStackTrace();
    }
    }
    }

    常见问题

    
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持