Send SMS via Tencent Cloud API with Spring Boot#

Step 1: Apply for SMS Service#

Open the Tencent Cloud console, apply for an SMS application, signature, and template.

Step 2: API Debugging#

You can quickly generate calling code on the Tencent Cloud API Explorer page.

Add the Dependency#

1
<dependency>
2
    <groupId>com.tencentcloudapi</groupId>
3
    <artifactId>tencentcloud-sdk-java</artifactId>
4
    <version>3.1.838</version>
5
</dependency>

Raw Calling Code#

1
public class SendSms {
2
    public static void main(String[] args) {
3
        try {
4
            Credential cred = new Credential("SecretId", "SecretKey");
5
            HttpProfile httpProfile = new HttpProfile();
6
            httpProfile.setEndpoint("sms.tencentcloudapi.com");
7

8
            ClientProfile clientProfile = new ClientProfile();
9
            clientProfile.setHttpProfile(httpProfile);
10

11
            SmsClient client = new SmsClient(cred, "ap-beijing", clientProfile);
12

13
            SendSmsRequest req = new SendSmsRequest();
14
            String[] phoneNumberSet1 = {"your-phone-number"};
15
            req.setPhoneNumberSet(phoneNumberSet1);
16
            req.setSmsSdkAppId("1400849908");
17
            req.setSignName("your-sign-name");
18
            req.setTemplateId("1907520");
19

20
            String[] templateParamSet1 = {"6666"};
21
            req.setTemplateParamSet(templateParamSet1);
22

23
            SendSmsResponse resp = client.SendSms(req);
24
            System.out.println(SendSmsResponse.toJsonString(resp));
25
        } catch (TencentCloudSDKException e) {
26
            System.out.println(e.toString());
27
        }
28
    }
29
}

Example response:

1
{
2
  "SendStatusSet": [
3
    {
4
      "SerialNo": "3369:294906593316931104718082751",
5
      "PhoneNumber": "your-phone-number",
6
      "Fee": 1,
7
      "Code": "Ok",
8
      "Message": "send success",
9
      "IsoCode": "CN"
10
    }
11
  ],
12
  "RequestId": "69aceba9-a43d-434c-9021-e7320ef52d49"
13
}

Step 3: Wrap as a Spring Boot Utility#

1. Configuration Properties#

1
myapp:
2
  secretId: your-secret-id
3
  secretKey: your-secret-key
4
  smsSdkAppId: your-sdk-app-id
5
  signName: your-sign-name
6
  templateId: your-template-id

2. Configuration Binding Class#

1
@Component
2
@ConfigurationProperties(prefix = "myapp")
3
public class MyAppProperties {
4
    private String secretId;
5
    private String secretKey;
6
    private String smsSdkAppId;
7
    private String signName;
8
    private String templateId;
9

10
    // getters and setters
11
}

Note: Don’t make set methods static, or @ConfigurationProperties won’t inject values properly.

3. SMS Utility Class#

1
@Component
2
@Slf4j
3
public class SmsUtil {
4
    private static SmsClient client = null;
5

6
    @PostConstruct
7
    public void init() {
8
        client = createClient(
9
            MyAppProperties.getSecretId(),
10
            MyAppProperties.getSecretKey()
11
        );
12
    }
13

14
    public static void sendVerificationCode(String phone, String code) {
15
        SendSmsRequest req = new SendSmsRequest();
16
        req.setPhoneNumberSet(new String[]{phone});
17
        req.setSmsSdkAppId(MyAppProperties.getSmsSdkAppId());
18
        req.setSignName(MyAppProperties.getSignName());
19
        req.setTemplateId(MyAppProperties.getTemplateId());
20
        req.setTemplateParamSet(new String[]{code});
21

22
        try {
23
            SendSmsResponse resp = client.SendSms(req);
24
            log.info("SMS send result: {}", SendSmsResponse.toJsonString(resp));
25
        } catch (TencentCloudSDKException e) {
26
            log.error("Failed to send SMS", e);
27
            throw new RuntimeException(e);
28
        }
29
    }
30

31
    private static SmsClient createClient(String secretId, String secretKey) {
32
        Credential cred = new Credential(secretId, secretKey);
33
        HttpProfile httpProfile = new HttpProfile();
34
        httpProfile.setEndpoint("sms.tencentcloudapi.com");
35
        ClientProfile clientProfile = new ClientProfile();
36
        clientProfile.setHttpProfile(httpProfile);
37
        return new SmsClient(cred, "ap-beijing", clientProfile);
38
    }
39
}

4. API Endpoint#

1
@RestController
2
public class SmsController {
3
    @GetMapping("/sms")
4
    public String sendSms() {
5
        SmsUtil.sendVerificationCode("your-phone", "1234");
6
        return "ok";
7
    }
8
}

Summary#

The evolution: API debugging (raw SDK) → externalized configuration (ConfigurationProperties) → static utility class (@PostConstruct initialization). In daily development, the wrapped utility class approach is recommended to avoid duplicating SDK calling logic across business code.

Music