Skip to content

smsaero/smsaero_java

Repository files navigation

SMS Aero Client library for Java

Maven Central License

Library for sending SMS messages using the SMS Aero API. Written in Java.

Requirements: Java 11 or higher. For Java 8, use v3.1.0.

API documentation: smsaero.ru/integration/documentation/api

Русская документация: README.RUS.md

Installation

Maven

<dependency>
  <groupId>ru.smsaero</groupId>
  <artifactId>smsaero</artifactId>
  <version>3.3.0</version>
</dependency>

Gradle

implementation 'ru.smsaero:smsaero:3.3.0'

Usage

Get credentials from account settings page: https://smsaero.ru/cabinet/settings/apikey/

import org.json.simple.JSONObject;
import ru.smsaero.SmsAero;

public class Main {
    private static final String email = "your email";
    private static final String apiKey = "your api key";

    public static void main(String[] args) {
        try {
            SmsAero client = new SmsAero(email, apiKey);

            // Send SMS
            JSONObject sendResult = client.SendSms("70000000000", "Hello, World!");
            System.out.println(sendResult.toString());

            // Send Telegram code
            JSONObject telegramResult = client.SendTelegram("70000000000", 1234, "SMS Aero", "Your code 1234");
            System.out.println(telegramResult.toString());
        } catch (Exception e) {
            System.err.println("An error occurred: " + e.getMessage());
            System.exit(-1);
        }
    }
}

Test mode

For development and debugging without sending real SMS or charging your account, use test mode:

SmsAero client = new SmsAero(email, apiKey);

// Enable Test mode
client.EnableTestMode();

// No real SMS are sent
JSONObject result = client.SendSms("70000000000", "Test");

// switch back to normal mode
client.DisableTestMode();

Check status: client.IsTestModeActive().

Command-line interface (CLI)

To send SMS from the command line, use the fat JAR smsaero-3.3.0-cli.jar:

java -jar target/smsaero-3.3.0-cli.jar --email YOUR_EMAIL --api_key YOUR_API_KEY --phone 70000000000 --message "Hello"

Docker

Run on Docker:

docker pull 'smsaero/smsaero_java:latest'
docker run --rm smsaero/smsaero_java:latest --email YOUR_EMAIL --api_key YOUR_API_KEY --phone 70000000000 --message "Hello"

Options:

  • --debug — test mode (no real SMS sent)
  • --sign — sender signature (default: "SMS Aero")

License

MIT License

About

Java client for working with SMSAero API

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors