ClickSend Java SDK

Official Java client for the ClickSend API — send and manage SMS, MMS, email, voice, fax, letters, postcards, and more.

Requirements

• Java 1.8+
• Maven (3.8.3+) / Gradle (7.2+)

Installation

Maven

<dependency>
  <groupId>com.clicksend</groupId>
  <artifactId>clicksend-java</artifactId>
  <version>1.0.0</version>
</dependency>

Gradle

implementation "com.clicksend:clicksend-java:1.0.0"

Getting Started

import ClickSend.ApiClient;
import ClickSend.ApiException;
import ClickSend.Configuration;
import ClickSend.auth.*;
import ClickSend.Api.SmsApi;
import ClickSend.Model.*;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername(System.getenv("CLICKSEND_USERNAME"));
        basicAuth.setPassword(System.getenv("CLICKSEND_API_KEY"));

        SmsApi apiInstance = new SmsApi(defaultClient);
        SendSmsRequest sendSmsRequest = new SendSmsRequest()
            .addMessagesItem(new SendSmsRequestMessagesInner()
                .body("Hello from ClickSend!")
                .to("+61411111111")
                .source("sdk"));

        try {
            SendSms result = apiInstance.sendSms(null, sendSmsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SmsApi#sendSms: " + e.getMessage());
        }
    }
}

More Examples

View account details

import ClickSend.Api.ManagementApi;
import ClickSend.Model.ViewAccountDetails;

ManagementApi managementApi = new ManagementApi(defaultClient);

try {
    ViewAccountDetails account = managementApi.viewAccountDetails(null);
    System.out.println(account);
} catch (ApiException e) {
    System.err.println("Exception when calling ManagementApi#viewAccountDetails: " + e.getMessage());
}

Send an MMS

import ClickSend.Api.MmsApi;
import ClickSend.Model.SendMms;
import ClickSend.Model.SendMmsRequest;
import ClickSend.Model.SendMmsRequestMessagesInner;

MmsApi mmsApi = new MmsApi(defaultClient);
SendMmsRequest sendMmsRequest = new SendMmsRequest()
    .mediaFile("https://clicksend.com/logo.png")
    .addMessagesItem(new SendMmsRequestMessagesInner()
        .to("+61411111111")
        .from("sdk")
        .subject("Hello")
        .body("Hello from ClickSend!")
        .source("sdk"));

try {
    SendMms result = mmsApi.sendMms(null, sendMmsRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MmsApi#sendMms: " + e.getMessage());
}

Authentication

The API uses HTTP Basic authentication — your ClickSend username and API key (available from the ClickSend Dashboard).

Documentation

Full API reference: https://developers.clicksend.com/docs/rest/v3/

Support

Need help? Contact ClickSend Support or visit the Help Centre.