openapi-java-client

The SMS Works API

• API version: 1.9.0
  • Build date: 2023-12-15T11:27:24.989260Z[Europe/London]

The SMS Works provides a low-cost, reliable SMS API for developers. Pay only for delivered texts, all failed UK messages are refunded.

For more information, please visit https://thesmsworks.co.uk/contact

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>org.openapitools</groupId>
  <artifactId>openapi-java-client</artifactId>
  <version>1.9.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'openapi-java-client' jar has been published to maven central.
    mavenLocal()       // Needed if the 'openapi-java-client' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "org.openapitools:openapi-java-client:1.9.0"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/openapi-java-client-1.9.0.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.BatchMessagesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.thesmsworks.co.uk/v1");
    
    // Configure API key authorization: JWT
    ApiKeyAuth JWT = (ApiKeyAuth) defaultClient.getAuthentication("JWT");
    JWT.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //JWT.setApiKeyPrefix("Token");

    BatchMessagesApi apiInstance = new BatchMessagesApi(defaultClient);
    Object messages = null; // Object | An array of messages
    try {
      BatchMessageResponse result = apiInstance.batchAnyPost(messages);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling BatchMessagesApi#batchAnyPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to https://api.thesmsworks.co.uk/v1

Class	Method	HTTP request	Description
BatchMessagesApi	batchAnyPost	POST /batch/any
BatchMessagesApi	batchBatchidGet	GET /batch/{batchid}
BatchMessagesApi	batchSchedulePost	POST /batch/schedule
BatchMessagesApi	batchSendPost	POST /batch/send
BatchMessagesApi	batchesScheduleBatchidDelete	DELETE /batches/schedule/{batchid}
CreditsApi	creditsBalanceGet	GET /credits/balance
MessagesApi	messageSchedulePost	POST /message/schedule
MessagesApi	messageSendPost	POST /message/send
MessagesApi	messagesFailedPost	POST /messages/failed
MessagesApi	messagesInboxPost	POST /messages/inbox
MessagesApi	messagesMessageidDelete	DELETE /messages/{messageid}
MessagesApi	messagesMessageidGet	GET /messages/{messageid}
MessagesApi	messagesPost	POST /messages
MessagesApi	messagesScheduleGet	GET /messages/schedule
MessagesApi	messagesScheduleMessageidDelete	DELETE /messages/schedule/{messageid}
MessagesApi	sendFlashMessage	POST /message/flash
OneTimePasswordApi	otpMessageidGet	GET /otp/{messageid}
OneTimePasswordApi	otpSendPost	POST /otp/send
OneTimePasswordApi	otpVerifyPost	POST /otp/verify
UtilsApi	utilsErrorsErrorcodeGet	GET /utils/errors/{errorcode}
UtilsApi	utilsTestGet	GET /utils/test

Documentation for Models

• BatchMessage
• BatchMessageResponse
• CancelledMessageResponse
• CreditsResponse
• DeletedMessageResponse
• ErrorModel
• ExtendedErrorModel
• Message
• MessageMetadata
• MessageResponse
• MessageResponseFailurereason
• MetaData
• OTP
• OTPResponse
• OTPVerify
• OTPVerifyResponse
• Query
• QueryMetadata
• ScheduledBatchResponse
• ScheduledMessage
• ScheduledMessageResponse
• ScheduledMessagesResponse
• ScheduledMessagesResponseMessage
• SendMessageResponse
• TestResponse

Documentation for Authorization

Authentication schemes defined for the API:

JWT

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

[email protected]