You need to enable JavaScript to run this app.
导航

Java SDK

最近更新时间2023.07.04 18:46:52

首次发布时间2023.07.04 18:46:52

为方便您更好地使用火山引擎短信服务,我们为开发者封装了SDK for Java,开发者可通过下载SDK直接调用短信服务。
以下将以SendSms接口为例,为您介绍如何下载SDK,并调用短信服务向收件人发送短信。

前置准备
  • 安装了Maven

    Maven 是一个功能强大的工具,支持将依赖项导入到项目中并自动管理依赖项。

  • 获取了AK (Access Key) 和 SK (Secret Key)

    • 如果您还没有获取AK/SK,可以通过以下方式获取:火山引擎 -> 账号 -> API访问密钥 -> 新建密钥

小贴士:一个火山引擎账号最多可以同时申请两对 AK/SK 。

alt


下载SDK for Java

SDK for Java 提供了示例 SendSmsDemo.java ,以便开发者可以快速调用SendSms API。
您可以根据以下步骤下载SDK:
方式一:
git clone https://github.com/volcengine/volc-sdk-java.git

方式二:

  1. 进入 GitHub - volcengine/volc-sdk-java

  2. 点击 Code -> Download ZIP



添加对 Maven pom.xml 文件的依赖

在 IDE 中,将 SDK 中的示例文件夹作为 Maven 项目打开,则以下 Maven 依赖项已添加到 pom.xml 文件中,因此您无需再次添加。 但如果您想将SDK集成到自己的项目中,则需要执行此步骤。 一旦添加到 Maven pom.xml 文件,依赖项将自动下载、更新,并由 Maven 管理其子依赖项。

<dependency> 
    <groupId>com.volcengine</groupId> 
    <artifactId>volc-sdk-java</artifactId> 
    <version>1.0.105</version> 
</dependency>

设置身份验证
  • 打开示例文件

  • 要通过 AK/SK 设置身份验证。可以按照下面的示例在示例文件中填写您的 AK 和 SK。

推荐按照以下方式设置身份验证:

SmsService smsService = SmsServiceImpl.getInstance(new SmsServiceInfoConfig("ak", "sk"));

使用SendSms API 发送文本短信
  1. 填写SendSmsDemo.java 正文部分中的参数,如下所示。参数含义请参考SendSms
package com.volcengine.example.sms;

import com.alibaba.fastjson.JSON;
import com.volcengine.model.request.SmsSendRequest;
import com.volcengine.model.response.SmsSendResponse;
import com.volcengine.service.sms.SmsService;
import com.volcengine.service.sms.SmsServiceInfoConfig;
import com.volcengine.service.sms.impl.SmsServiceImpl;

import java.io.IOException;
import java.util.*;

public class SendSmsDemo {
    private static SmsService smsService = SmsServiceImpl.getInstance(new SmsServiceInfoConfig("ak", "sk"));

    public static void main(String[] args) throws IOException {

        SmsSendRequest req = new SmsSendRequest();
        req.setPhoneNumbers("136XX08XXXX");
        req.setSmsAccount("subaccount");
        req.setTemplateId("templateid");
        req.setSign("signature");

        Map<String,String> param = new HashMap<>();
        param.put("content","第一行\n第二行");
        req.setTemplateParamByMap(param);

        try {
            SmsSendResponse response = smsService.sendV2(req);
            System.out.println(JSON.toJSONString(response));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}
  1. 右击并运行java

发送结果

短信发送后,您将收到一条包含MessageID的发送成功的响应。响应参数详见SendSms