oneapi.model

Class SubscribeToDeliveryNotificationsRequest

java.lang.Object

oneapi.model.SubscribeToDeliveryNotificationsRequest

public class SubscribeToDeliveryNotificationsRequest
extends Object

Constructor Summary

Constructors

Constructor and Description
SubscribeToDeliveryNotificationsRequest()
SubscribeToDeliveryNotificationsRequest(String notifyURL)
SubscribeToDeliveryNotificationsRequest(String senderAddress, String notifyURL) Start subscribing to delivery status notifications over OneAPI for all your sent SMS
SubscribeToDeliveryNotificationsRequest(String senderAddress, String notifyURL, String criteria, String clientCorrelator, String callbackData) Start subscribing to delivery status notifications over OneAPI for all your sent SMS

Method Summary

Modifier and Type	Method and Description
String	getCallbackData() (optional) will be passed back to the notifyURL location, so you can use it to identify the message the delivery receipt relates to (or any other useful data, such as a function name)
String	getClientCorrelator() (optional) optional) uniquely identifies this subscription request.
String	getCriteria() criteria (optional) Text in the message to help you route the notification to a specific application.
String	getNotifyURL() (mandatory) is the URL to which you would like a notification of delivery sent
String	getSenderAddress() (mandatory) is the address from which SMS messages are being sent.
void	setCallbackData(String callbackData) (optional) will be passed back to the notifyURL location, so you can use it to identify the message the delivery receipt relates to (or any other useful data, such as a function name)
void	setClientCorrelator(String clientCorrelator) (optional) optional) uniquely identifies this subscription request.
void	setCriteria(String criteria) criteria (optional) Text in the message to help you route the notification to a specific application.
void	setNotifyURL(String notifyURL) (mandatory) is the URL to which you would like a notification of delivery sent
void	setSenderAddress(String senderAddress) (mandatory) is the address from which SMS messages are being sent.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscribeToDeliveryNotificationsRequest

public SubscribeToDeliveryNotificationsRequest()

SubscribeToDeliveryNotificationsRequest

public SubscribeToDeliveryNotificationsRequest(String notifyURL)

SubscribeToDeliveryNotificationsRequest

public SubscribeToDeliveryNotificationsRequest(String senderAddress,
                                               String notifyURL)

Start subscribing to delivery status notifications over OneAPI for all your sent SMS

Parameters:

senderAddress - is the address from which SMS messages are being sent. Do not URL encode this value prior to passing to this function

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

SubscribeToDeliveryNotificationsRequest

public SubscribeToDeliveryNotificationsRequest(String senderAddress,
                                               String notifyURL,
                                               String criteria,
                                               String clientCorrelator,
                                               String callbackData)

Start subscribing to delivery status notifications over OneAPI for all your sent SMS

Parameters:

senderAddress - (mandatory) is the address from which SMS messages are being sent. Do not URL encode this value prior to passing to this function

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

criteria - (optional) Text in the message to help you route the notification to a specific application. For example you may ask users to ‘text GIGPICS to 12345′ for your rock concert photos application. This text is matched against the first word, as defined as the initial characters after discarding any leading Whitespace and ending with a Whitespace or end of the string. The matching shall be case-insensitive.

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

callbackData - (optional) will be passed back to the notifyURL location, so you can use it to identify the message the delivery receipt relates to (or any other useful data, such as a function name)

Method Detail

getSenderAddress

public String getSenderAddress()

(mandatory) is the address from which SMS messages are being sent. Do not URL encode this value prior to passing to this function

Returns:

senderAddress

setSenderAddress

public void setSenderAddress(String senderAddress)

(mandatory) is the address from which SMS messages are being sent. Do not URL encode this value prior to passing to this function

getNotifyURL

public String getNotifyURL()

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

Returns:

notifyURL

setNotifyURL

public void setNotifyURL(String notifyURL)

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

getCriteria

public String getCriteria()

criteria (optional) Text in the message to help you route the notification to a specific application. For example you may ask users to ‘text GIGPICS to 12345′ for your rock concert photos application. This text is matched against the first word, as defined as the initial characters after discarding any leading Whitespace and ending with a Whitespace or end of the string. The matching shall be case-insensitive.

Returns:

criteria

setCriteria

public void setCriteria(String criteria)

criteria (optional) Text in the message to help you route the notification to a specific application. For example you may ask users to ‘text GIGPICS to 12345′ for your rock concert photos application. This text is matched against the first word, as defined as the initial characters after discarding any leading Whitespace and ending with a Whitespace or end of the string. The matching shall be case-insensitive.

getClientCorrelator

public String getClientCorrelator()

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

Returns:

clientCorrelator

setClientCorrelator

public void setClientCorrelator(String clientCorrelator)

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

setCallbackData

public void setCallbackData(String callbackData)

(optional) will be passed back to the notifyURL location, so you can use it to identify the message the delivery receipt relates to (or any other useful data, such as a function name)

getCallbackData

public String getCallbackData()

(optional) will be passed back to the notifyURL location, so you can use it to identify the message the delivery receipt relates to (or any other useful data, such as a function name)

Returns:

callbackData