Como enviar mensagens SMS com Java e a API da Vonage

Este artigo foi atualizado em abril de 2025

A SMS API da Vonage é um serviço que permite enviar e receber mensagens SMS. Se você é um desenvolvedor Java, pode usar a API da Vonage para enviar mensagens SMS a partir de aplicativos Java.

Neste tutorial, vamos mostrar como enviar mensagens SMS com Java usando a API da Vonage.

Pré-requisitos

Usar Java para enviar mensagens SMS é relativamente simples. Depois de ter a SMS API da Vonage, basta ter algumas ferramentas adicionais e um conhecimento prático de Java.

Você também precisará do seguinte:

• JDK (17 ou superior) ou seu equivalente de código aberto, o OpenJDK

• Gradle

Instruções

A seguir, vamos explicar cada uma das etapas necessárias para enviar uma mensagem SMS em Java usando a API da Vonage.

1. Crie seu aplicativo Java

2. Configurar o SDK Java da Vonage

3. Envie sua mensagem SMS em Java

1. Crie seu aplicativo Java

Para começar, configure seu projeto Gradle e baixe o SDK Java da Vonage.

Crie um diretório para o seu projeto. Entre nesse diretório e execute gradle init. Se você não estiver familiarizado com o Gradle, não se preocupe — não vamos nos aprofundar em nada excessivamente complexo!

Selecione 1: básico como o tipo de projeto a ser gerado. 1: Groovy como DSL do script de compilação. Nesse momento, nomeie seu projeto — ou pressione Enter para aceitar a opção padrão.

Quando isso estiver concluído, abra o build.gradle arquivo. Em seguida, substitua o conteúdo do arquivo pelo seguinte trecho de código:

// We're creating a Java Application:
    plugins {
        id 'application'
        id 'java'
    }
    
    // Download dependencies from Maven Central:
    repositories {
        mavenCentral()
    }
    
    // Install the Vonage Java SDK
    dependencies {
        implementation 'com.vonage:client:7.7.0'
    }
    
    // We'll create this class to contain our code:
    application {
        mainClass = 'getstarted.SendSMS'
    }

Em seguida, abra o terminal no diretório que contém seu build.gradle arquivo. Em seguida, execute o seguinte comando:

gradle build

Este comando fará o download do SDK Java da Vonage e o armazenará para uso posterior. Se você tivesse algum código-fonte, ele também o compilaria — mas você ainda não escreveu nenhum. Vamos resolver isso!

2. Configurar o SDK Java da Vonage

Devido à mainClass configuração que definimos no arquivo de compilação do Gradle, você precisará criar uma classe chamada SendSMS no pacote getstarted.

(Observação: no código de produção, seria recomendável que o pacote fosse algo como com.mycoolcompany.smstool, mas como este não é um código de produção, então getstarted já serve.)

O Gradle usa a mesma estrutura de diretórios que o Maven; portanto, você precisa criar a seguinte estrutura de diretórios dentro do diretório do seu projeto: src/main/java/getstarted.

No macOS e no Linux, você pode criar esse caminho executando:

mkdir -p src/main/java/getstarted

Dentro do getstarted diretório, crie um arquivo chamado SendSMS.java. Depois de abri-lo no seu IDE preferido, adicione este código:

package getstarted;

import com.vonage.client.VonageClient;
import com.vonage.client.sms.MessageStatus;
import com.vonage.client.sms.SmsSubmissionResponse;
import com.vonage.client.sms.messages.TextMessage;

static String API_KEY = "YOUR_API_KEY";
static String API_SECRET = "YOUR_API_SECRET";

public class SendSMS {

    public static void main(String[] args) throws Exception {
    // Our code will go here!
    }
}

Isso importa as partes necessárias do SDK da Vonage e cria um método para o nosso código.

Em seguida, armazenamos nossa chave de API e nosso segredo de API como variáveis. Preencha YOUR_API_KEY e YOUR_API_SECRET com os valores que você copiou do Painel da API da Vonage.

Se você executar gradle run, ele deve executar seu método main. No entanto, como ainda não temos nada lá, ele não fará nada. Vamos mudar isso!

3. Envie sua mensagem SMS em Java

Agora, estamos quase prontos para enviar uma mensagem SMS com nosso aplicativo Java!

Primeiro, adicione este trecho ao seu main método:

VonageClient client = VonageClient.builder()
    
    .apiKey(YOUR_API_KEY)
    .apiSecret(YOUR_API_SECRET)
    .build();

O código a seguir cria um VonageClient objeto que pode ser usado para enviar mensagens SMS. Agora que seu objeto cliente está configurado, você pode enviar uma mensagem SMS:

TextMessage message = new TextMessage(VONAGE_BRAND_NAME,
                    TO_NUMBER,
                    "A text message sent using the Vonage SMS API"
            );
    
            SmsSubmissionResponse response = client.getSmsClient().submitMessage(message);
    
            if (response.getMessages().get(0).getStatus() == MessageStatus.OK) {
                System.out.println("Message sent successfully. " + response.getMessages());
            } else {
                System.out.println("Message failed with error: " + response.getMessages().get(0).getErrorText());
            }

Mais uma vez, você deverá substituir VONAGE_BRAND_NAME pelo número virtual que você comprou e TO_NUMBER pelo seu próprio número de celular. Ambos devem ser escritos como strings. Certifique-se de fornecer o TO_NUMBER no formato E.164—por exemplo, 447401234567.

Por fim, salve e execute gradle run. Se você seguiu corretamente as etapas deste tutorial, isso enviará uma mensagem SMS a partir do Java usando a SMS API da Vonage.

Neste momento, você deve ver algo parecido com isto:

Message sent successfully.[com.vonage.client.sms.SmsSubmissionResponseMessage@f0f0675[to=447401234567,id=13000001CA6CCC59,status=OK,remainingBalance=27.16903818,messagePrice=0.03330000,network=23420,errorText=<null>,clientRef=<null>]]

...e uma mensagem de texto enviada para o seu celular!

Se não funcionou, pode haver algum texto após ERR:. Corrija o problema e tente novamente.

NOTA

Em alguns países (EUA), VONAGE_BRAND_NAME deve ser um dos seus números virtuais da Vonage. Em outros países (Reino Unido), você pode escolher livremente um valor alfanumérico — por exemplo, o nome da sua marca, como AcmeInc. Leia sobre os recursos de SMS específicos de cada país no portal de desenvolvedores.

Conclusão

Agora você já sabe como enviar um SMS em Java usando a SMS API da Vonage! Para mais informações, consulte os links da documentação fornecidos abaixo.

Leitura complementar

• Informações gerais sobre a SMS API

• Documentação da SMS API

• Documentação sobre o envio de SMS