com.smsjuice.api.wrapper.domain.model

Class Message

java.lang.Object

com.smsjuice.api.wrapper.domain.model.Message

public class Message
extends java.lang.Object

Author:

Wilson Mazaiwana

Constructor Summary

Constructors

Constructor and Description
Message(java.lang.String key, java.lang.String secret, RecipientType recipientType, int templateId) Constructor Takes key and secret which are provided in the settings page of your account
Message(java.lang.String key, java.lang.String secret, RecipientType recipientType, java.lang.String messageContent) Constructor Takes key and secret which are provided in the settings page of your account
Message(java.lang.String key, java.lang.String secret, java.lang.String recipientType) Deprecated.

Method Summary

Modifier and Type	Method and Description
Message	addRecipient(java.lang.String recipient) For adding a new recipient to the list of recipients to receive messages.
Message	addRecipientList(java.util.List<java.lang.String> to) For adding a list of recipients to receive the message to be sent
int	getEncoding() Returns the value of the encoding set.
java.time.LocalDate	getExpiry() Returns the expiry date for when the message is to be deemed useless if not received by the recipient.
java.lang.String	getFrom() Returns the from address to be used in the message.
java.lang.String	getKey()
java.lang.String	getMessage() Returns the message content to be sent.
int	getReceipt() Returns the value indicating whether a receipt is required or not.
RecipientType	getRecipientType() Returns the indicator for what type of recipients are in the recipients list, whether it is a group or individual recipients
java.time.LocalDate	getSchedule() Returns the schedule date for when the message is to be sent.
java.lang.String	getSecret()
int	getTemplateId()
java.util.List<java.lang.String>	getTo() Returns the recipient list, or group list depending on what was put in.
Message	setEncoding(int encoding) - Optional - Sets the character encoding to go along with the message.
Message	setExpiryDate(java.lang.String expiryDate) setExpiryDate - Optional - Sets the date the system will stop trying to deliver the message if that recipient is not available to receive the message at that time.
Message	setFrom(java.lang.String from) Set the "from" address/number.
Message	setMessage(java.lang.String messageContent) Deprecated.
Message	setReceiptOption(int receiptIndicator) setReceiptOption - Optional - Sets whether a receipt is relayed to the provided callback url or not.
Message	setRecipientType(java.lang.String type) Sets the type of recipient, as user can send to a list of numbers, or a to list of groups on their account
Message	setSendDate(java.lang.String sendDate) setSendDate - Optional - Sets date and time to send message.

Methods inherited from class java.lang.Object

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

Constructor Detail

Message

public Message(java.lang.String key,
               java.lang.String secret,
               java.lang.String recipientType)
        throws MessageException,
               RecipientTypeException

Deprecated.

Constructor Takes key and secret which are provided in the settings page of your account

Parameters:

key - SMSJuice account key

secret - SMSJuice account secret

Throws:

MessageException

RecipientTypeException

Message

public Message(java.lang.String key,
               java.lang.String secret,
               RecipientType recipientType,
               java.lang.String messageContent)
        throws MessageException

Constructor Takes key and secret which are provided in the settings page of your account

Parameters:

key - SMSJuice account key

secret - SMSJuice account secret

recipientType - Type of recipients to send to. On your SMSjuice account you have groups of numbers, and individual numbers. This distinguishes whether you are sending to groups or individual numbers

messageContent - The actual content of the message that will be read by the recipient(s)

Throws:

MessageException

Message

public Message(java.lang.String key,
               java.lang.String secret,
               RecipientType recipientType,
               int templateId)
        throws MessageException

Constructor Takes key and secret which are provided in the settings page of your account

Parameters:

key - SMSJuice account key

secret - SMSJuice account secret

recipientType - Type of recipients to send to. On your SMSjuice account you have groups of numbers, and individual numbers. This distinguishes whether you are sending to groups or individual numbers

templateId - the ID of the template stored on your SMSJuice account that you wish to use as message content

Throws:

MessageException

Method Detail

setFrom

public Message setFrom(java.lang.String from)
                throws MessageException

Set the "from" address/number. This is what the person sees at the top of the message as the "from number". This can be up to 11 alpha-numeric characters OR up to 15 digits only. If it is an international number (MSISDN) the make sure it starts with the country code. No leading double zeros or leading plus.

Parameters:

from - The "from" address/number

Throws:

MessageException

addRecipient

public Message addRecipient(java.lang.String recipient)
                     throws ContactException

For adding a new recipient to the list of recipients to receive messages.

Parameters:

recipient - mobile phone to receive the message

Throws:

MessageException

ContactException

addRecipientList

public Message addRecipientList(java.util.List<java.lang.String> to)

For adding a list of recipients to receive the message to be sent

Parameters:

to - List of recipient phone numbers OR group names

Returns:

Message object

setRecipientType

public Message setRecipientType(java.lang.String type)
                         throws RecipientTypeException

Sets the type of recipient, as user can send to a list of numbers, or a to list of groups on their account

Parameters:

type - Recipient type determining whether the recipient list is made of numbers or group names

Returns:

Message object

Throws:

RecipientTypeException

setMessage

public Message setMessage(java.lang.String messageContent)
                   throws MessageException

Deprecated.

Sets the message content that is intended for the recipient to read. Content can be up to 765 characters (5 SMS)

Parameters:

messageContent - message content to send

Returns:

Message object

Throws:

MessageException

setReceiptOption

public Message setReceiptOption(int receiptIndicator)
                         throws MessageException

setReceiptOption - Optional - Sets whether a receipt is relayed to the provided callback url or not. 1 for yes , 0 for no. Default is 0

Parameters:

receiptIndicator - indicator for whether a receipt is needed or not

Returns:

Message object

Throws:

MessageException

setSendDate

public Message setSendDate(java.lang.String sendDate)
                    throws MessageException

setSendDate - Optional - Sets date and time to send message. Time set to London time

Parameters:

sendDate - date and time to send the message

Throws:

MessageException

setExpiryDate

public Message setExpiryDate(java.lang.String expiryDate)
                      throws MessageException

setExpiryDate - Optional - Sets the date the system will stop trying to deliver the message if that recipient is not available to receive the message at that time. Default is 2 days from send date.

Parameters:

expiryDate -

Throws:

MessageException

getKey

public java.lang.String getKey()

getSecret

public java.lang.String getSecret()

getReceipt

public int getReceipt()

Returns the value indicating whether a receipt is required or not. A receipt is sent to a URL of your choice, and this is set in your settings page on your account

Returns:

receipt value. 0 or 1. Default = 1.

getEncoding

public int getEncoding()

Returns the value of the encoding set. If none is set then the default 0 is returned (and subsequently used if a message is sent)

Returns:

encoding value between 0 and 8 inclusive.

setEncoding

public Message setEncoding(int encoding)
                    throws MessageException

- Optional - Sets the character encoding to go along with the message. If message is unicode and no encoding is set SMSJuice API will detect the message and put the appropriate encoding, so no really need to use this.

Parameters:

encoding - The encoding caluse to use. Recommendation is to use 0, 3 or 8 as values as they are the most commonly used. The default is 0 if one doesn't select which one they want to use, and it usually suffices.

Returns:

Message object

Throws:

MessageException - triggered when one tries to instantiate the object with a value less than 0 or grater than 8 .

getFrom

public java.lang.String getFrom()

Returns the from address to be used in the message. This is the address that one sees on their phone as the sender of the message

Returns:

From-address

getMessage

public java.lang.String getMessage()

Returns the message content to be sent.

Returns:

Message content to be sent

getSchedule

public java.time.LocalDate getSchedule()

Returns the schedule date for when the message is to be sent. Can return null if not set, since it's optional

Returns:

Date for when message is to be sent

getExpiry

public java.time.LocalDate getExpiry()

Returns the expiry date for when the message is to be deemed useless if not received by the recipient. Can return null if not set, since it's optional

Returns:

Date for when message expires

getTo

public java.util.List<java.lang.String> getTo()

Returns the recipient list, or group list depending on what was put in.

Returns:

The recipient list, or group list

getRecipientType

public RecipientType getRecipientType()

Returns the indicator for what type of recipients are in the recipients list, whether it is a group or individual recipients

Returns:

Receipient type indicator

getTemplateId

public int getTemplateId()