OmnimessageApi.md

OmnimessageApi

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

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

cancelScheduledMessage

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.omnichannel.OmnimessageApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

OmnimessageApi apiInstance = new OmnimessageApi();
UUID omnimessageId = new UUID(); // UUID | UUID of the scheduled Omnimessage to be cancelled
try {
    apiInstance.cancelScheduledMessage(omnimessageId);
} catch (ApiException e) {
    System.err.println("Exception when calling OmnimessageApi#cancelScheduledMessage");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
omnimessageId	UUID	UUID of the scheduled Omnimessage to be cancelled

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

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

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.omnichannel.OmnimessageApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

OmnimessageApi apiInstance = new OmnimessageApi();
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");
    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