MessagesApi

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

Method	HTTP request	Description
messageSchedulePost	POST /message/schedule
messageSendPost	POST /message/send
messagesFailedPost	POST /messages/failed
messagesInboxPost	POST /messages/inbox
messagesMessageidDelete	DELETE /messages/{messageid}
messagesMessageidGet	GET /messages/{messageid}
messagesPost	POST /messages
messagesScheduleGet	GET /messages/schedule
messagesScheduleMessageidDelete	DELETE /messages/schedule/{messageid}
sendFlashMessage	POST /message/flash

messageSchedulePost

List<ScheduledMessageResponse> messageSchedulePost(smsMessage)

Schedules an SMS message to be sent at the date-time you specify

Example

// 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.MessagesApi;

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");

    MessagesApi apiInstance = new MessagesApi(defaultClient);
    Message smsMessage = new Message(); // Message | Message properties
    try {
      List<ScheduledMessageResponse> result = apiInstance.messageSchedulePost(smsMessage);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MessagesApi#messageSchedulePost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
smsMessage	Message	Message properties

Return type

List<ScheduledMessageResponse>

Authorization

JWT

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	Success	-
0	Error	-

messageSendPost

SendMessageResponse messageSendPost(smsMessage)

Send an SMS Message

Example

// 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.MessagesApi;

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");

    MessagesApi apiInstance = new MessagesApi(defaultClient);
    Message smsMessage = new Message(); // Message | Message properties
    try {
      SendMessageResponse result = apiInstance.messageSendPost(smsMessage);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MessagesApi#messageSendPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
smsMessage	Message	Message properties

Return type

SendMessageResponse

Authorization

JWT

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
201	Success	-
402	Error	-
0	Error	-

messagesFailedPost

List<MessageResponse> messagesFailedPost(query)

Get failed messages matching your search criteria

Example

// 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.MessagesApi;

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");

    MessagesApi apiInstance = new MessagesApi(defaultClient);
    Query query = new Query(); // Query | 
    try {
      List<MessageResponse> result = apiInstance.messagesFailedPost(query);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MessagesApi#messagesFailedPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
query	Query

Return type

List<MessageResponse>

Authorization

JWT

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	Success	-
0	Error	-

messagesInboxPost

List<MessageResponse> messagesInboxPost(query)

Get unread uncoming messages matching your search criteria

Example

// 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.MessagesApi;

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");

    MessagesApi apiInstance = new MessagesApi(defaultClient);
    Query query = new Query(); // Query | 
    try {
      List<MessageResponse> result = apiInstance.messagesInboxPost(query);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MessagesApi#messagesInboxPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
query	Query

Return type

List<MessageResponse>

Authorization

JWT

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	Success	-
0	Error	-

messagesMessageidDelete

DeletedMessageResponse messagesMessageidDelete(messageid)

Delete the message with the mathcing messageid

Example

// 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.MessagesApi;

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");

    MessagesApi apiInstance = new MessagesApi(defaultClient);
    String messageid = "messageid_example"; // String | The ID of the message you would like returned
    try {
      DeletedMessageResponse result = apiInstance.messagesMessageidDelete(messageid);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MessagesApi#messagesMessageidDelete");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
messageid	String	The ID of the message you would like returned

Return type

DeletedMessageResponse

Authorization

JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Error	-
0	Error	-

messagesMessageidGet

MessageResponse messagesMessageidGet(messageid)

Retrieve a logged message by the message ID

Example

// 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.MessagesApi;

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");

    MessagesApi apiInstance = new MessagesApi(defaultClient);
    String messageid = "messageid_example"; // String | The ID of the message you would like returned
    try {
      MessageResponse result = apiInstance.messagesMessageidGet(messageid);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MessagesApi#messagesMessageidGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
messageid	String	The ID of the message you would like returned

Return type

MessageResponse

Authorization

JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	Success	-
404	Error	-
0	Error	-

messagesPost

List<MessageResponse> messagesPost(query)

Retrieve up to 1000 messages matching your search criteria

Example

// 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.MessagesApi;

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");

    MessagesApi apiInstance = new MessagesApi(defaultClient);
    Query query = new Query(); // Query | 
    try {
      List<MessageResponse> result = apiInstance.messagesPost(query);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MessagesApi#messagesPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
query	Query

Return type

List<MessageResponse>

Authorization

JWT

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	Success	-
0	Error	-

messagesScheduleGet

ScheduledMessagesResponse messagesScheduleGet()

Returns a list of messages scheduled from your account, comprising any messages scheduled in the last 3 months and any scheduled to send in the future

Example

// 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.MessagesApi;

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");

    MessagesApi apiInstance = new MessagesApi(defaultClient);
    try {
      ScheduledMessagesResponse result = apiInstance.messagesScheduleGet();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MessagesApi#messagesScheduleGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

ScheduledMessagesResponse

Authorization

JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	Success	-
0	Error	-

messagesScheduleMessageidDelete

CancelledMessageResponse messagesScheduleMessageidDelete(messageid)

Cancels a scheduled SMS message

Example

// 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.MessagesApi;

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");

    MessagesApi apiInstance = new MessagesApi(defaultClient);
    String messageid = "messageid_example"; // String | The ID of the message you would like returned
    try {
      CancelledMessageResponse result = apiInstance.messagesScheduleMessageidDelete(messageid);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MessagesApi#messagesScheduleMessageidDelete");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
messageid	String	The ID of the message you would like returned

Return type

CancelledMessageResponse

Authorization

JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
200	Success	-
0	Error	-

sendFlashMessage

SendMessageResponse sendFlashMessage(smsMessage)

Sends an SMS flash message, which appears on the recipients lock screen

Example

// 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.MessagesApi;

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");

    MessagesApi apiInstance = new MessagesApi(defaultClient);
    Message smsMessage = new Message(); // Message | Message properties
    try {
      SendMessageResponse result = apiInstance.sendFlashMessage(smsMessage);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MessagesApi#sendFlashMessage");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
smsMessage	Message	Message properties

Return type

SendMessageResponse

Authorization

JWT

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

HTTP response details

Status code	Description	Response headers
201	Success	-
402	Error	-
0	Error	-

Uh oh!

FilesExpand file tree

MessagesApi.md

Latest commit

History

MessagesApi.md

File metadata and controls

MessagesApi

messageSchedulePost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

messageSendPost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

messagesFailedPost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

messagesInboxPost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

messagesMessageidDelete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

messagesMessageidGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

messagesPost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

messagesScheduleGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

messagesScheduleMessageidDelete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

sendFlashMessage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details