OmnimessageApi.md

OmnichannelApi.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

var OmnichannelApi = require('omnichannel_api');
var defaultClient = OmnichannelApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new OmnichannelApi.OmnimessageApi();
var omnimessageId = null; // String | UUID of the scheduled Omnimessage to be cancelled
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.cancelScheduledMessage(omnimessageId, callback);

Parameters

Name	Type	Description	Notes
omnimessageId	String	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

var OmnichannelApi = require('omnichannel_api');
var defaultClient = OmnichannelApi.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new OmnichannelApi.OmnimessageApi();
var omnimessage = new OmnichannelApi.Omnimessage(); // Omnimessage | Omnimessage to be sent
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.sendOmnimessage(omnimessage, callback);

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