Sinch Developer Documentation

Building blocks to enable rich customer communication

Java

Tutorials for our Java SDK

Sinch ❤ Java

In this section you'll find tutorials specific to using the Sinch REST API from the Java platform.

Installing the Java SDK

Installing with Maven/Gradle

Using Maven/Gradle is the recommended way to install the SDK. You can add this sdk to your existing project.
In Maven, please put the lines below in your pom.xml

  <dependency>
      <groupId>com.sinch</groupId>
      <artifactId>sdk-sms</artifactId>
      <version>1.0.3</version>
  </dependency>

In Gradle, please put the lines below in your build.gradle

implementation 'com.sinch:sdk-sms:1.0.3'

Because Sinch SDK Library is hosted on Maven Central Repository, please make sure you have mavenCentral() in your build.gradle.

repositories {
    mavenCentral()
}

Using without a build automation tool

While we recommend using a package manager to track the dependencies in your application, it is possible to download and use the Java SDK by downloading a pre-built jar file. Select the directory for the latest version and download one of these jar files:

  • sdk-sms-{version}-jar-with-dependencies.jar
  • sdk-sms-{version}.jar

Installing the SDK locally

It is possible to download and use the Java SDK manually by downloading a pre-built jar file.

Please have Maven install in your environment in advance.

Clone the source code, and install the library.

git clone https://github.com/sinch/sinch-java-sms.git
cd sinch-java-sms    
mvn clean install

If you encounter "Permission Denied", please run

    $ sudo mvn clean install

If you need to skip local tests

    $ mvn package -Dmaven.test.skip=true

The jar file is under target folder

There are two available jar

sdk-sms-1.0.3-SNAPSHOT-jar-with-dependencies.jar 
sdk-sms-1.0.3-SNAPSHOT.jar -- Use this if you need to include version dependencies on your own.

Importing jar with Intellij

Follow this step

File -> Project Structure -> Modules -> Plus Sign -> Browse the SDK SMS Jar.

Importing jar with Eclipse

Follow this step

Project -> Build Path -> Configure Build Path -> Libraries -> Add Jar.

Set up Api Client

String SERVICE_PLAN_ID = "SERVICE_PLAN_ID";
String TOKEN = "SERVICE_TOKEN";
ApiConnection conn =
        ApiConnection.builder()
            .servicePlanId(SERVICE_PLAN_ID)
            .token(TOKEN)
            .start()

Sending Text Message

String SENDER = "SENDER"; // Optional
String [] RECIPIENTS = {"1232323131", "3213123"}  ;
MtBatchTextSmsResult batch =
          conn.createBatch(
              SinchSMSApi.batchTextSms()
                  .sender(SENDER)
                  .addRecipient(RECIPIENTS)
                  .body("Something good")
                  .build());

Sending Group Message

      // Creating simple Group
      GroupResult group = conn.createGroup(SinchSMSApi.groupCreate().name("Subscriber").build());

      // Adding members (numbers) into the group
      conn.updateGroup(
          group.id(), SinchSMSApi.groupUpdate().addMemberInsertion("15418888", "323232").build());

      // Sending a message to the group
      MtBatchTextSmsResult batch = conn.createBatch(
          SinchSMSApi.batchTextSms()
              .addRecipient(group.id().toString())
              .body("Something good")
              .build());

      System.out.println("Successfully sent batch " + batch.id());

Edit on GitHub

Updated 3 months ago


What's Next

Check out our Java tutorials here

Send an SMS to one or more ad-hoc recipients

Java


Tutorials for our Java SDK

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.