Skip to content

Latest commit

 

History

History
146 lines (112 loc) · 4.61 KB

OmnimessageApi.md

File metadata and controls

146 lines (112 loc) · 4.61 KB

OmnimessageApi

All URIs are relative to https://api.messente.com/v1

Method HTTP request Description
cancelScheduledMessage DELETE /omnimessage/{omnimessageId} Cancels a scheduled Omnimessage
sendOmnimessage POST /omnimessage Sends an Omnimessage

cancelScheduledMessage

Object cancelScheduledMessage(omnimessageId)

Cancels a scheduled Omnimessage

Example

// Import classes:
import com.messente.ApiClient;
import com.messente.ApiException;
import com.messente.Configuration;
import com.messente.auth.*;
import com.messente.models.*;
import com.messente.api.OmnimessageApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.messente.com/v1");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    OmnimessageApi apiInstance = new OmnimessageApi(defaultClient);
    UUID omnimessageId = UUID.randomUUID(); // UUID | UUID of the scheduled omnimessage to be cancelled
    try {
      Object result = apiInstance.cancelScheduledMessage(omnimessageId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OmnimessageApi#cancelScheduledMessage");
      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
omnimessageId UUID UUID of the scheduled omnimessage to be cancelled

Return type

Object

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Scheduled omnimessage successfully cancelled -
401 Unauthorized -
404 If the omnimessage has already been sent or no such message exists -

sendOmnimessage

OmniMessageCreateSuccessResponse sendOmnimessage(omnimessage)

Sends an Omnimessage

Example

// Import classes:
import com.messente.ApiClient;
import com.messente.ApiException;
import com.messente.Configuration;
import com.messente.auth.*;
import com.messente.models.*;
import com.messente.api.OmnimessageApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.messente.com/v1");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    OmnimessageApi apiInstance = new OmnimessageApi(defaultClient);
    Omnimessage omnimessage = new Omnimessage(); // Omnimessage | Omnimessage to be sent
    try {
      OmniMessageCreateSuccessResponse result = apiInstance.sendOmnimessage(omnimessage);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling OmnimessageApi#sendOmnimessage");
      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
omnimessage Omnimessage Omnimessage to be sent

Return type

OmniMessageCreateSuccessResponse

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Omnimessage success response -
400 Invalid input -
401 Unauthorized -