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

importClickSend.ApiClient;
importClickSend.ApiException;
importClickSend.Configuration;
importClickSend.auth.*;
importClickSend.Api.SmsApi;
importClickSend.Model.*;
publicclassExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
HttpBasicAuthbasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername(System.getenv("CLICKSEND_USERNAME"));
basicAuth.setPassword(System.getenv("CLICKSEND_API_KEY"));
SmsApiapiInstance = newSmsApi(defaultClient);
SendSmsRequestsendSmsRequest = newSendSmsRequest()
.addMessagesItem(newSendSmsRequestMessagesInner()
.body("Hello from ClickSend!")
.to("+61411111111")
.source("sdk"));
try {
SendSmsresult = apiInstance.sendSms(null, sendSmsRequest);
System.out.println(result);
} catch (ApiExceptione) {
System.err.println("Exception when calling SmsApi#sendSms: " + e.getMessage());
}
}
}

More Examples

View account details

importClickSend.Api.ManagementApi;
importClickSend.Model.ViewAccountDetails;
ManagementApimanagementApi = newManagementApi(defaultClient);
try {
ViewAccountDetailsaccount = managementApi.viewAccountDetails(null);
System.out.println(account);
} catch (ApiExceptione) {
System.err.println("Exception when calling ManagementApi#viewAccountDetails: " + e.getMessage());
}

Send an MMS

importClickSend.Api.MmsApi;
importClickSend.Model.SendMms;
importClickSend.Model.SendMmsRequest;
importClickSend.Model.SendMmsRequestMessagesInner;
MmsApimmsApi = newMmsApi(defaultClient);
SendMmsRequestsendMmsRequest = newSendMmsRequest()
.mediaFile("https://clicksend.com/logo.png")
.addMessagesItem(newSendMmsRequestMessagesInner()
.to("+61411111111")
.from("sdk")
.subject("Hello")
.body("Hello from ClickSend!")
.source("sdk"));
try {
SendMmsresult = mmsApi.sendMms(null, sendMmsRequest);
System.out.println(result);
} catch (ApiExceptione) {
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.