> For the complete documentation index, see [llms.txt](https://help.clickatell.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.clickatell.com/developers-api-reference/developers-archive/sdks/java.md).

# Java

ARCHIVED

**Overview**

Used for server applications and mobile development. After signing up, use this Java library to build into your system. You can use this Java library with our HTTP or REST messaging APIs to interact with the Clickatell SMS Gateway. The Java library below allows you to send one- or two-way SMS messages using Clickatell’s SMS Platform.

[View on GitHub](https://github.com/clickatell/clickatell-java)

You can see our other libraries and more documentation at the [Clickatell APIs and Libraries Project](http://clickatell.github.io/).

\
**Usage**

Copy the class files directly into your project and reference the JSON-simple-1.1.1.jar library. Then use as described below.

\
**To initialize:**

| `ClickatellHttp click = new` `ClickatellHttp(USERNAME, APIID, PASSWORD);ClickatellRest clickRest = new` `ClickatellRest(API_KEY);` |
| ---------------------------------------------------------------------------------------------------------------------------------- |

 

**To send one message:**

| `ClickatellHttp.Message response = click.sendMessage("27821234567",                    "Hello, this is a test message!");ClickatellRest.Message response = clickRest.sendMessage("27821234567",                    "Hello, this is a test message!");` |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

 

\
**To get the status of a message:**

| `int` `status = click.getMessageStatus("b305c3445e37626ffabb21edc9320e1e");` |
| ---------------------------------------------------------------------------- |

 

\
**To get the cost of a message:**

| `ClickatellHttp.Message reply = click.getMessageCharge("b305c3445e37626ffabb21edc9320e1e");System.out.println("Charge: "` `+ reply.charge);System.out.println("Status: "` `+ reply.status);` |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

 

\
**To get the cost and status of the message in REST:**

| `ClickatellRest.Message msg = clickRest.getMessageStatus(response.message_id);System.out.println("ID:"` `+ msg.message_id);System.out.println("Status:"` `+ msg.status);System.out.println("Status Description:"` `+ msg.statusString);System.out.println("Charge:"` `+ msg.charge);` |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

 

\
**To do a coverage check:**

| `double` `reply = click.getCoverage("27820909090");` |
| ---------------------------------------------------- |

 

\
**To do a message stop request:**

| `click.stopMessage("b305c3445e37626ffabb21edc9320e1e");` |
| -------------------------------------------------------- |

 

\
**To check your balance:**

| `double` `balance = click.getBalance();` |
| ---------------------------------------- |

 

\
**Testing sample code**

**Compile:**

| `javac -cp json-simple-1.1.1.jar ClickatellRest.java ClickatellHttp.java Runner.java` |
| ------------------------------------------------------------------------------------- |

 

**Run:**

| `java -cp .:json-simple-1.1.1.jar Runner` |
| ----------------------------------------- |

 

\
**Clickatell Java library – platform branch**

This SDK is based on the new Clickatell platform. Instead of checking out this codebase, you can download the Clickatell-java-sdk.jar file from <https://github.com/clickatell/clickatell-java/tree/platform/bin/artifacts/clickatell_java_sdk_jar>.

**Testing**

Testing can be done by editing the classes *TestClickatellHttp* and *TestClickatellRest.* You will need to supply your *apiKey* along with the number you would like to send the message to.

&#x20;


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.clickatell.com/developers-api-reference/developers-archive/sdks/java.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.