oneapi.model

Class SMSRequest

java.lang.Object

oneapi.model.SMSRequest

public class SMSRequest
extends Object

Constructor Summary

Constructors

Constructor and Description
SMSRequest()
SMSRequest(String senderAddress, String message, String... recipientAddress) Initialize SMS object using mandatory parameters
SMSRequest(String senderAddress, String message, String clientCorrelator, String notifyURL, String senderName, String callbackData, String... recipientAddress) Initialize SMS object using mandatory parameters

Method Summary

Modifier and Type	Method and Description
String[]	getAddress() (mandatory) contains one address for end user ID to send to
String	getCallbackData() (optional) will be passed back to the notifyURL location, so you can use it to identify the message the receipt relates to (or any other useful data, such as a function name)
String	getClientCorrelator() (optional) uniquely identifies this create MMS request.
Language	getLanguage() (optional) if using Turkish, Spanish or Portuguese language.
String	getMessage() (mandatory) contains the message text to send
String	getNotifyURL() (optional) is the URL to which you would like a notification of delivery sent
String	getSenderAddress() (mandatory) is the address to whom a responding SMS may be sent
String	getSenderName() (optional) is the name to appear on the user's terminal as the sender of the message
void	setAddress(String[] address) (mandatory) contains one address for end user ID to send to
void	setCallbackData(String callbackData) (optional) will be passed back to the notifyURL location, so you can use it to identify the message the receipt relates to (or any other useful data, such as a function name)
void	setClientCorrelator(String clientCorrelator) (optional) uniquely identifies this create MMS request.
void	setLanguage(Language language) (optional) is NLI information
void	setMessage(String message) (mandatory) contains the message text to send
void	setNotifyURL(String notifyURL) (optional) is the URL to which you would like a notification of delivery sent
void	setSenderAddress(String senderAddress) (mandatory) is the address to whom a responding SMS may be sent
void	setSenderName(String senderName) (optional) is the name to appear on the user's terminal as the sender of the message

Methods inherited from class java.lang.Object

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

Constructor Detail

SMSRequest

public SMSRequest()

SMSRequest

public SMSRequest(String senderAddress,
                  String message,
                  String... recipientAddress)

Initialize SMS object using mandatory parameters

Parameters:

senderAddress - is the address to whom a responding SMS may be sent

recipientAddress - contains one or more addresses for end user ID to send to

message - contains the message text to send

SMSRequest

public SMSRequest(String senderAddress,
                  String message,
                  String clientCorrelator,
                  String notifyURL,
                  String senderName,
                  String callbackData,
                  String... recipientAddress)

Initialize SMS object using mandatory parameters

Parameters:

senderAddress - is the address to whom a responding SMS may be sent

recipientAddress - contains one or more addresses for end user ID to send to

message - contains the message text to send

clientCorrelator - uniquely identifies this create MMS request. If there is a communication failure during the request, using the same clientCorrelator when retrying the request allows the operator to avoid sending the same MMS twice.

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

senderName - is the name to appear on the user's terminal as the sender of the message

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

Method Detail

getSenderAddress

public String getSenderAddress()

(mandatory) is the address to whom a responding SMS may be sent

Returns:

senderAddress

setSenderAddress

public void setSenderAddress(String senderAddress)

(mandatory) is the address to whom a responding SMS may be sent

getAddress

public String[] getAddress()

(mandatory) contains one address for end user ID to send to

Returns:

recipientsAddress

setAddress

public void setAddress(String[] address)

(mandatory) contains one address for end user ID to send to

getMessage

public String getMessage()

(mandatory) contains the message text to send

setMessage

public void setMessage(String message)

(mandatory) contains the message text to send

getClientCorrelator

public String getClientCorrelator()

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

Returns:

clientCorrelator

setClientCorrelator

public void setClientCorrelator(String clientCorrelator)

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

getNotifyURL

public String getNotifyURL()

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

Returns:

notifyURL

setNotifyURL

public void setNotifyURL(String notifyURL)

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

getSenderName

public String getSenderName()

(optional) is the name to appear on the user's terminal as the sender of the message

Returns:

senderName

setSenderName

public void setSenderName(String senderName)

(optional) is the name to appear on the user's terminal as the sender of the message

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 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 receipt relates to (or any other useful data, such as a function name)

Returns:

callbackData

getLanguage

public Language getLanguage()

(optional) if using Turkish, Spanish or Portuguese language. Be aware thar NLI information is defined in User Data Header (UDH), which reduces the available message length by 5 characters.

Returns:

language

See Also:

http://en.wikipedia.org/wiki/GSM_03.38

setLanguage

public void setLanguage(Language language)

(optional) is NLI information