tencent cloud

Feedback

SDK for Java

Last updated: 2024-05-20 18:24:32
    SDK 3.0 is a companion tool for the TencentCloud API 3.0 platform. You can use all SMS APIs through the SDK. The new SDK version is unified and features the same SDK usage, API call methods, error codes, and returned packet formats for different programming languages.
    Note:
    API version required for connecting to Tencent Cloud International:
    SMS API v2021-01-11 is required. For details, see the sample code.
    SMS sending APIs:
    One message can be sent to up to 200 numbers at a time.
    Signature and body template APIs:
    Individual users have no permission to use signature and body template APIs and can manage SMS signatures and SMS body templates only in the SMS console. To use the APIs, change "Individual Identity" to "Organizational Identity".

    Prerequisites

    You have learned about the concept of region and selected a region as needed.
    You have activated SMS. For detailed directions, please see Getting Started.
    You have prepared the dependent environment: JDK 7 or above.
    You have obtained the SecretID and SecretKey on the API Key Management page in the CAM console.
    SecretID is used to identify the API caller.
    SecretKey is used to encrypt the string to sign that can be verified on the server. You should keep it private and avoid disclosure.
    The endpoint of the SMS service is sms.tencentcloudapi.com.

    Relevant Documents

    For more information on the APIs and their parameters, please see API Documentation.
    You can download the SDK source code from Github Repository.

    Installing SDK

    Installing via Maven (recommended)

    See Github Repository: Installing via Maven (recommended)

    Installing via source package

    See Github repository: Installing via source package

    Sample Code

    Note:
    All samples are for reference only and cannot be directly compiled and executed. You need to modify them based on your actual needs. You can also use API 3.0 Explorer to automatically generate the demo code as needed.
    Each API has a corresponding request structure and a response structure. This document only lists the sample code of several common features as shown below:

    Sending SMS message

    import com.tencentcloudapi.common.Credential;
    import com.tencentcloudapi.common.exception.TencentCloudSDKException;
    
    // Import the optional configuration classes
    import com.tencentcloudapi.common.profile.ClientProfile;
    import com.tencentcloudapi.common.profile.HttpProfile;
    
    // Import the client of the corresponding SMS module
    import com.tencentcloudapi.sms.v20210111.SmsClient;
    
    // Import the request response class corresponding to the request API
    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 {
    /* Required steps:
    * Instantiate an authentication object. The Tencent Cloud account key pair `secretId` and `secretKey` need to be passed in as the input parameters.
    * The example here uses the way to read from the environment variable, so you need to set these two values in the environment variable first.
    * You can also write the key pair directly into the code, but be careful not to copy, upload, or share the code to others;
    * otherwise, the key pair may be leaked, causing damage to your properties.
    * Query the CAM key: https://console.tencentcloud.com/cam/capi*/
    Credential cred = new Credential("secretId", "secretKey");
    
    // (Optional) Instantiate an HTTP option
    HttpProfile httpProfile = new HttpProfile();
    // Set the proxy
    // httpProfile.setProxyHost("real proxy ip");
    // httpProfile.setProxyPort(real proxy port);
    /* The SDK uses the POST method by default
    * If you have to use the GET method, you can set it here, but the GET method cannot handle some large requests */
    httpProfile.setReqMethod("POST");
    /* The SDK has a default timeout period. Do not adjust it unless absolutely necessary
    * If needed, check in the code to get the latest default value */
    httpProfile.setConnTimeout(60);
    /* The SDK automatically specifies the domain name. Generally, you don't need to specify a domain name, but if you are accessing a service in a finance zone,
    * you need to manually specify the domain name. For example, the SMS domain name of the Shanghai Finance Zone is `sms.ap-shanghai-fsi.tencentcloudapi.com` */
    httpProfile.setEndpoint("sms.tencentcloudapi.com");
    
    /* Optional steps:
    * Instantiate a client configuration object. You can specify the timeout period and other configuration items */
    ClientProfile clientProfile = new ClientProfile();
    /* The SDK uses `TC3-HMAC-SHA256` to sign by default
    * Do not modify this field unless absolutely necessary */
    clientProfile.setSignMethod("HmacSHA256");
    clientProfile.setHttpProfile(httpProfile);
    /* Instantiate the client object of the requested product (with SMS as an example)
    * The second parameter is the information on the region you select in Tencent Cloud International. If you select Singapore, you should enter the string `ap-singapore`. Click https://www.tencentcloud.com/document/api/382/40466?lang=en#region-list to view the region list. */
    SmsClient client = new SmsClient(cred, "ap-singapore",clientProfile);
    /* Instantiate a request object. You can further set the request parameters according to the API called and actual conditions
    * You can directly check the SDK source code to determine which attributes of the API can be set
    * An attribute may be of a basic type or import another data structure
    * We recommend you use the IDE for development where you can easily redirect to and view the documentation of each API and data structure */
    SendSmsRequest req = new SendSmsRequest();
    
    /* Populate the request parameters. Here, the member variables of the request object are the input parameters of the corresponding API
    * You can view the definition of the request parameters in the API documentation at the official website or by redirecting to the definition of the request object
    * Settings of a basic parameter:
    * Help link:
    * SMS console: https://console.tencentcloud.com/smsv2
    * sms helper: https://www.tencentcloud.com/document/product/382/3773?from_cn_redirect=1 */
    
    /* SMS application ID, which is the `SdkAppId` generated after an application is added in the [SMS console], such as 1400006666 */
    String sdkAppId = "1400009099";
    req.setSmsSdkAppId(sdkAppId);
    
    /* SMS signature content, which should be encoded in UTF-8. You must enter an approved signature, which can be viewed in the [SMS console] */
    String signName = "Signature content";
    req.setSignName(signName);
    
    /* `SenderId` for Global SMS, which is not activated by default. If you need to activate it, please contact [SMS Helper] for assistance. This parameter should be left empty for Mainland China SMS */
    String senderid = "";
    req.setSenderId(senderid);
    
    /* User session content, which can carry context information such as user-side ID and will be returned as-is by the server */
    String sessionContext = "xxx";
    req.setSessionContext(sessionContext);
    
    /* SMS code number extension, which is not activated by default. If you need to activate it, please contact [SMS Helper] */
    String extendCode = "";
    req.setExtendCode(extendCode);
    
    /* Template ID. You must enter the ID of an approved template, which can be viewed in the [SMS console] */
    String templateId = "400000";
    req.setTemplateId(templateId);
    
    /* Target mobile number in the E.164 standard (+[country/region code][mobile number])
    * Example: +8613711112222, which has a + sign followed by 86 (country/region code) and then by 13711112222 (mobile number). Up to 200 mobile numbers are supported */
    String[] phoneNumberSet = {"+8621212313123", "+8612345678902", "+8612345678903"};
    req.setPhoneNumberSet(phoneNumberSet);
    
    /* Template parameters. If there are no template parameters, leave it empty */
    String[] templateParamSet = {"5678"};
    req.setTemplateParamSet(templateParamSet);
    
    /* Initialize the request by calling the `SendSms` method on the client object. Note: the request method name corresponds to the request object
    * The returned `res` is an instance of the `SendSmsResponse` class which corresponds to the request object */
    SendSmsResponse res = client.SendSms(req);
    
    // A string return packet in JSON format is output
    System.out.println(SendSmsResponse.toJsonString(res));
    
    // You can also take a single value. You can view the definition of the return field in the API documentation at the official website or by redirecting to the definition of the response object
    System.out.println(res.getRequestId());
    
    } catch (TencentCloudSDKException e) {
    e.printStackTrace();
    }
    }
    }

    Pulling receipt status

    import com.tencentcloudapi.common.Credential;
    import com.tencentcloudapi.common.exception.TencentCloudSDKException;
    
    // Import the optional configuration classes
    import com.tencentcloudapi.common.profile.ClientProfile;
    import com.tencentcloudapi.common.profile.HttpProfile;
    
    // Import the client of the corresponding SMS module
    import com.tencentcloudapi.sms.v20210111.SmsClient;
    
    // Import the request response class corresponding to the request API
    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 {
    /* Required steps:
    * Instantiate an authentication object. The Tencent Cloud account key pair `secretId` and `secretKey` need to be passed in as the input parameters.
    * The example here uses the way to read from the environment variable, so you need to set these two values in the environment variable first.
    * You can also write the key pair directly into the code, but be careful not to copy, upload, or share the code to others;
    * otherwise, the key pair may be leaked, causing damage to your properties.
    * Query the CAM key: https://console.tencentcloud.com/cam/capi*/
    Credential cred = new Credential("secretId", "secretKey");
    
    // (Optional) Instantiate an HTTP option
    HttpProfile httpProfile = new HttpProfile();
    // Set the proxy
    // httpProfile.setProxyHost("real proxy ip");
    // httpProfile.setProxyPort(real proxy port);
    /* The SDK uses the POST method by default
    * If you have to use the GET method, you can set it here, but the GET method cannot handle some large requests */
    httpProfile.setReqMethod("POST");
    /* The SDK has a default timeout period. Do not adjust it unless absolutely necessary
    * If needed, check in the code to get the latest default value */
    httpProfile.setConnTimeout(60);
    /* The SDK automatically specifies the domain name. Generally, you don't need to specify a domain name, but if you are accessing a service in a finance zone,
    * you need to manually specify the domain name. For example, the SMS domain name of the Shanghai Finance Zone is `sms.ap-shanghai-fsi.tencentcloudapi.com` */
    httpProfile.setEndpoint("sms.tencentcloudapi.com");
    
    /* Optional steps:
    * Instantiate a client configuration object. You can specify the timeout period and other configuration items */
    ClientProfile clientProfile = new ClientProfile();
    /* The SDK uses `TC3-HMAC-SHA256` to sign by default
    * Do not modify this field unless absolutely necessary */
    clientProfile.setSignMethod("HmacSHA256");
    clientProfile.setHttpProfile(httpProfile);
    
    /* Instantiate the client object of the requested product (with SMS as an example)
    * The second parameter is the information on the region you select in Tencent Cloud International. If you select Singapore, you should enter the string `ap-singapore`. Click https://www.tencentcloud.com/document/api/382/40466?lang=en#region-list to view the region list. */
    SmsClient client = new SmsClient(cred, "ap-singapore", clientProfile);
    
    /* Instantiate a request object. You can further set the request parameters according to the API called and actual conditions
    * You can directly check the SDK source code to determine which attributes of the API can be set
    * An attribute may be of a basic type or import another data structure
    * We recommend you use the IDE for development where you can easily redirect to and view the documentation of each API and data structure */
    PullSmsSendStatusRequest req = new PullSmsSendStatusRequest();
    
    /* Populate the request parameters. Here, the member variables of the request object are the input parameters of the corresponding API
    * You can view the definition of the request parameters in the API documentation at the official website or by redirecting to the definition of the request object
    * Settings of a basic parameter:
    * Help link:
    * SMS console: https://console.tencentcloud.com/smsv2
    * sms helper: https://www.tencentcloud.com/document/product/382/3773?from_cn_redirect=1 */
    
    /* SMS application ID, which is the `SdkAppId` generated after an application is added in the [SMS console], such as 1400006666 */
    String sdkAppId = "1400009099";
    req.setSmsSdkAppId(sdkAppId);
    
    // Set the maximum number of pulled entries. Maximum value: 100
    Long limit = 5L;
    req.setLimit(limit);
    
    /* Initialize the request by calling the `PullSmsSendStatus` method on the client object. Note: the request method name corresponds to the request object
    * The returned `res` is an instance of the `PullSmsSendStatusResponse` class which corresponds to the request object */
    PullSmsSendStatusResponse res = client.PullSmsSendStatus(req);
    
    // A string return packet in JSON format is output
    System.out.println(PullSmsSendStatusResponse.toJsonString(res));
    
    } catch (TencentCloudSDKException e) {
    e.printStackTrace();
    }
    }
    }

    Collecting SMS message sending data

    import com.tencentcloudapi.common.Credential;
    import com.tencentcloudapi.common.exception.TencentCloudSDKException;
    
    // Import the optional configuration classes
    import com.tencentcloudapi.common.profile.ClientProfile;
    import com.tencentcloudapi.common.profile.HttpProfile;
    
    // Import the client of the corresponding SMS module
    import com.tencentcloudapi.sms.v20210111.SmsClient;
    
    // Import the request response class corresponding to the request API
    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 {
    /* Required steps:
    * Instantiate an authentication object. The Tencent Cloud account key pair `secretId` and `secretKey` need to be passed in as the input parameters.
    * The example here uses the way to read from the environment variable, so you need to set these two values in the environment variable first.
    * You can also write the key pair directly into the code, but be careful not to copy, upload, or share the code to others;
    * otherwise, the key pair may be leaked, causing damage to your properties.
    * Query the CAM key: https://console.tencentcloud.com/cam/capi*/
    Credential cred = new Credential("secretId", "secretKey");
    
    // (Optional) Instantiate an HTTP option
    HttpProfile httpProfile = new HttpProfile();
    // Set the proxy
    // httpProfile.setProxyHost("real proxy ip");
    // httpProfile.setProxyPort(real proxy port);
    /* The SDK uses the POST method by default
    * If you have to use the GET method, you can set it here, but the GET method cannot handle some large requests */
    httpProfile.setReqMethod("POST");
    /* The SDK has a default timeout period. Do not adjust it unless absolutely necessary
    * If needed, check in the code to get the latest default value */
    httpProfile.setConnTimeout(60);
    /* The SDK automatically specifies the domain name. Generally, you don't need to specify a domain name, but if you are accessing a service in a finance zone,
    * you need to manually specify the domain name. For example, the SMS domain name of the Shanghai Finance Zone is `sms.ap-shanghai-fsi.tencentcloudapi.com` */
    httpProfile.setEndpoint("sms.tencentcloudapi.com");
    
    /* Optional steps:
    * Instantiate a client configuration object. You can specify the timeout period and other configuration items */
    ClientProfile clientProfile = new ClientProfile();
    /* The SDK uses `TC3-HMAC-SHA256` to sign by default
    * Do not modify this field unless absolutely necessary */
    clientProfile.setSignMethod("HmacSHA256");
    clientProfile.setHttpProfile(httpProfile);
    
    /* Instantiate the client object of the requested product (with SMS as an example)
    * The second parameter is the information on the region you select in Tencent Cloud International. If you select Singapore, you should enter the string `ap-singapore`. Click https://www.tencentcloud.com/document/api/382/40466?lang=en#region-list to view the region list. */
    SmsClient client = new SmsClient(cred, "ap-singapore",clientProfile);
    
    /* Instantiate a request object. You can further set the request parameters according to the API called and actual conditions
    * You can directly check the SDK source code to determine which attributes of the API can be set
    * An attribute may be of a basic type or import another data structure
    * We recommend you use the IDE for development where you can easily redirect to and view the documentation of each API and data structure */
    SendStatusStatisticsRequest req = new SendStatusStatisticsRequest();
    
    /* Populate the request parameters. Here, the member variables of the request object are the input parameters of the corresponding API
    * You can view the definition of the request parameters in the API documentation at the official website or by redirecting to the definition of the request object
    * Settings of a basic parameter:
    * Help link:
    * SMS console: https://console.tencentcloud.com/smsv2
    * sms helper: https://www.tencentcloud.com/document/product/382/3773?from_cn_redirect=1 */
    
    /* SMS application ID, which is the `SdkAppId` generated after an application is added in the [SMS console], such as 1400006666 */
    String sdkAppId = "1400009099";
    req.setSmsSdkAppId(sdkAppId);
    
    // Set the maximum number of pulled entries. Maximum value: 100
    Long limit = 5L;
    req.setLimit(limit);
    /* Offset. Note: this parameter is currently fixed at 0 */
    Long offset = 0L;
    req.setOffset(offset);
    /* Start time of pull in the format of `yyyymmddhh` accurate to the hour */
    String beginTime = "2019071100";
    req.setBeginTime(beginTime);
    /* End time of pull in the format of `yyyymmddhh` accurate to the hour
    * Note: `EndTime` must be after `beginTime` */
    String endTime = "2019071123";
    req.setEndTime(endTime);
    
    /* Initialize the request by calling the `SendStatusStatistics` method on the client object. Note: the request method name corresponds to the request object
    * The returned `res` is an instance of the `SendStatusStatisticsResponse` class which corresponds to the request object */
    SendStatusStatisticsResponse res = client.SendStatusStatistics(req);
    
    // A string return packet in JSON format is output
    System.out.println(SendStatusStatisticsResponse.toJsonString(res));
    
    } catch (TencentCloudSDKException e) {
    e.printStackTrace();
    }
    }
    }

    Applying for SMS template

    import com.tencentcloudapi.common.Credential;
    import com.tencentcloudapi.common.exception.TencentCloudSDKException;
    // Import the optional configuration classes
    import com.tencentcloudapi.common.profile.ClientProfile;
    import com.tencentcloudapi.common.profile.HttpProfile;
    // Import the client of the SMS module
    import com.tencentcloudapi.sms.v20210111.SmsClient;
    // Import the request response class corresponding to the request API
    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 {
    /* Required steps:
    * Instantiate an authentication object. The Tencent Cloud account key pair `secretId` and `secretKey` need to be passed in as the input parameters
    * This example uses the way to read from the environment variable, so you need to set these two values in the environment variable in advance
    * You can also write the key pair directly into the code, but be careful not to copy, upload, or share the code to others
    * Query the CAM key: https://console.tencentcloud.com/cam/capi
    */
    Credential cred = new Credential("secretId", "secretKey");
    // Instantiate an HTTP option (optional; skip if there are no special requirements)
    HttpProfile httpProfile = new HttpProfile();
    // Set the proxy
    // httpProfile.setProxyHost("real proxy ip");
    // httpProfile.setProxyPort(real proxy port);
    /* The SDK uses the POST method by default
    * If you need to use the GET method, you can set it here, but the GET method cannot handle some large requests */
    httpProfile.setReqMethod("POST");
    /* The SDK has a default timeout period. Do not adjust it unless absolutely necessary
    * If needed, check in the code to get the latest default value */
    httpProfile.setConnTimeout(60);
    /* The SDK automatically specifies the domain name. Generally, you don't need to specify a domain name, but if you are accessing a service in a finance AZ, you must manually specify the domain name
    * For example, the SMS domain name of the Shanghai Finance Zone is `sms.ap-shanghai-fsi.tencentcloudapi.com` */
    httpProfile.setEndpoint("sms.tencentcloudapi.com");
    /* Optional steps:
    * Instantiate a client configuration object. You can specify the timeout period and other configuration items */
    ClientProfile clientProfile = new ClientProfile();
    /* The SDK uses `TC3-HMAC-SHA256` to sign by default
    * Do not modify this field unless absolutely necessary */
    clientProfile.setSignMethod("HmacSHA256");
    clientProfile.setHttpProfile(httpProfile);
    /* Instantiate an SMS client object
    * The second parameter is the information on the region you select in Tencent Cloud International. If you select Singapore, you should enter the string `ap-singapore`. Click https://www.tencentcloud.com/document/api/382/40466?lang=en#region-list to view the region list. */
    SmsClient client = new SmsClient(cred, "ap-singapore", clientProfile);
    /* Instantiate a request object. You can further set the request parameters according to the API called and actual conditions
    * You can directly check the SDK source code to determine which attributes of the API can be set
    * An attribute may be of a basic type or import another data structure
    * We recommend you use the IDE for development where you can easily redirect to and view the documentation of each API and data structure */
    AddSmsTemplateRequest req = new AddSmsTemplateRequest();
    /* Populate the request parameters. Here, the member variables of the request object are the input parameters of the corresponding API
    * You can view the definition of the request parameters in the API documentation at the official website or by redirecting to the definition of the request object
    * Settings of a basic parameter:
    * Help link:
    * SMS console: https://console.tencentcloud.com/smsv2
    * sms helper:https://www.tencentcloud.com/document/product/382/3773?from_cn_redirect=1 */
    /* Template name */
    String templatename = "Tencent Cloud";
    req.setTemplateName(templatename);
    /* Template content */
    String templatecontent = "Your login verification code is {1}. Please enter it within {2} minutes. If the login was not initiated by you, please ignore this message.";
    req.setTemplateContent(templatecontent);
    /* SMS type. 1: Marketing SMS, 2: Notification SMS, 3: OTP SMS */
    long smstype = 3;
    req.setSmsType(smstype);
    /* Whether it is Global SMS. 0: Mainland China SMS; 1: Global SMS */
    long international = 0;
    req.setInternational(international);
    /* Template remarks, such as reason for application and use case */
    String remark = "xxx";
    req.setRemark(remark);
    /* Initialize the request by calling the `AddSmsTemplate` method on the client object. Note: the request method name corresponds to the request object
    * The returned `res` is an instance of the `AddSmsTemplateResponse` class which corresponds to the request object */
    AddSmsTemplateResponse res = client.AddSmsTemplate(req);
    // A string return packet in JSON format is output
    System.out.println(AddSmsTemplateResponse.toJsonString(res));
    // You can take a single value. You can view the definition of the return field in the API documentation at the official website or by redirecting to the definition of the response object
    System.out.println(res.getRequestId());
    } catch (TencentCloudSDKException e) {
    e.printStackTrace();
    }
    }
    }

    FAQs

    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support