oneapi.model

Class SubscribeToInboundMessagesRequest

java.lang.Object

oneapi.model.SubscribeToInboundMessagesRequest

public class SubscribeToInboundMessagesRequest
extends Object

Constructor Summary

Constructors

Constructor and Description
SubscribeToInboundMessagesRequest()
SubscribeToInboundMessagesRequest(String notifyURL)
SubscribeToInboundMessagesRequest(String destinationAddress, String notifyURL) Start subscribing to notifications of SMS messages sent to your application
SubscribeToInboundMessagesRequest(String destinationAddress, String notifyURL, String criteria, String notificationFormat, String clientCorrelator, String callbackData) Start subscribing to notifications of SMS messages sent to your application

Method Summary

Modifier and Type	Method and Description
String	getCallbackData() (optional) is a function name or other data that you would like included when the POST is sent to your application
String	getClientCorrelator() (optional) uniquely identifies this create subscription request.
String	getCriteria() (optional) is case-insensitve text to match against the first word of the message, ignoring any leading whitespace.
String	getDestinationAddress() (mandatory) is the address/ MSISDN, or code agreed with the operator, to which people may send an SMS to your application
String	getNotificationFormat() (optional) is the content type that notifications will be sent in Đ for OneAPI v1.0 only JSON is supported
String	getNotifyURL() (mandatory) is the URL to which you would like a notification of message receipts sent
void	setCallbackData(String callbackData) (optional) is a function name or other data that you would like included when the POST is sent to your application
void	setClientCorrelator(String clientCorrelator) (optional) uniquely identifies this create subscription request.
void	setCriteria(String criteria) (optional) is case-insensitve text to match against the first word of the message, ignoring any leading whitespace.
void	setDestinationAddress(String destinationAddress) (mandatory) is the address/ MSISDN, or code agreed with the operator, to which people may send an SMS to your application
void	setNotificationFormat(String notificationFormat) (optional) is the content type that notifications will be sent in Đ for OneAPI v1.0 only JSON is supported
void	setNotifyURL(String notifyURL) (mandatory) is the URL to which you would like a notification of message receipts sent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubscribeToInboundMessagesRequest

public SubscribeToInboundMessagesRequest()

SubscribeToInboundMessagesRequest

public SubscribeToInboundMessagesRequest(String notifyURL)

SubscribeToInboundMessagesRequest

public SubscribeToInboundMessagesRequest(String destinationAddress,
                                         String notifyURL)

Start subscribing to notifications of SMS messages sent to your application

Parameters:

destinationAddress - is the address/ MSISDN, or code agreed with the operator, to which people may send an SMS to your application

notifyURL - is the URL to which you would like a notification of message receipts sent

SubscribeToInboundMessagesRequest

public SubscribeToInboundMessagesRequest(String destinationAddress,
                                         String notifyURL,
                                         String criteria,
                                         String notificationFormat,
                                         String clientCorrelator,
                                         String callbackData)

Start subscribing to notifications of SMS messages sent to your application

Parameters:

destinationAddress - (mandatory) is the address/ MSISDN, or code agreed with the operator, to which people may send an SMS to your application

notifyURL - (mandatory) is the URL to which you would like a notification of message receipts sent

criteria - (optional) is case-insensitve text to match against the first word of the message, ignoring any leading whitespace. This allows you to reuse a short code among various applications, each of which can register their own subscription with different criteria

notificationFormat - (optional) is the content type that notifications will be sent in Đ for OneAPI v1.0 only JSON is supported

clientCorrelator - (optional) uniquely identifies this create subscription request. If there is a communication failure during the request, using the same clientCorrelator when retrying the request allows the operator to avoid creating a duplicate subscription

callbackData - (optional) is a function name or other data that you would like included when the POST is sent to your application

Method Detail

getDestinationAddress

public String getDestinationAddress()

(mandatory) is the address/ MSISDN, or code agreed with the operator, to which people may send an SMS to your application

Returns:

destinationAddress

setDestinationAddress

public void setDestinationAddress(String destinationAddress)

(mandatory) is the address/ MSISDN, or code agreed with the operator, to which people may send an SMS to your application

getNotifyURL

public String getNotifyURL()

(mandatory) is the URL to which you would like a notification of message receipts sent

Returns:

notifyURL

setNotifyURL

public void setNotifyURL(String notifyURL)

(mandatory) is the URL to which you would like a notification of message receipts sent

getCriteria

public String getCriteria()

(optional) is case-insensitve text to match against the first word of the message, ignoring any leading whitespace. This allows you to reuse a short code among various applications, each of which can register their own subscription with different criteria

Returns:

criteria

setCriteria

public void setCriteria(String criteria)

(optional) is case-insensitve text to match against the first word of the message, ignoring any leading whitespace. This allows you to reuse a short code among various applications, each of which can register their own subscription with different criteria

getNotificationFormat

public String getNotificationFormat()

(optional) is the content type that notifications will be sent in Đ for OneAPI v1.0 only JSON is supported

Returns:

notificationFormat

setNotificationFormat

public void setNotificationFormat(String notificationFormat)

(optional) is the content type that notifications will be sent in Đ for OneAPI v1.0 only JSON is supported

getClientCorrelator

public String getClientCorrelator()

(optional) uniquely identifies this create subscription request. If there is a communication failure during the request, using the same clientCorrelator when retrying the request allows the operator to avoid creating a duplicate subscription

Returns:

clientCorrelator

setClientCorrelator

public void setClientCorrelator(String clientCorrelator)

(optional) uniquely identifies this create subscription request. If there is a communication failure during the request, using the same clientCorrelator when retrying the request allows the operator to avoid creating a duplicate subscription

setCallbackData

public void setCallbackData(String callbackData)

(optional) is a function name or other data that you would like included when the POST is sent to your application

getCallbackData

public String getCallbackData()

(optional) is a function name or other data that you would like included when the POST is sent to your application

Returns:

callbackData