com.smsjuice.api.wrapper

Class TextMessagingService

java.lang.Object

com.smsjuice.api.wrapper.TextMessagingService

public class TextMessagingService
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
TextMessagingService()

Method Summary

Modifier and Type	Method and Description
static javax.ws.rs.core.Response	addContactsToGroup(ContactGroup group) Add new contacts to a group of contacts.
static javax.ws.rs.core.Response	addNewGroup(ContactGroup group) Adds a new contact group onto your account as one would add from the SMSJuice web account.
static javax.ws.rs.core.Response	addNewTemplate(MessageTemplate template) Adds a new canned-message/template for sending to the recipient.
static javax.ws.rs.core.Response	addRecipientRateLimitRule(RecipientLimitRule rule) Sets a rate limit rule for recipients.
static ContactGroup	createContactGroupInstance(java.lang.String key, java.lang.String secret, java.lang.String groupName) Creates an instance of a group in which you can add contacts
static Message	createMessageInstance(java.lang.String key, java.lang.String secret, RecipientType recipientType, int templateId) Creates an instance of a message object which stores all aspects of the message (from, to-list, receiptwanted, encoding, sending schedule date, expiry date of the message, udhi )
static Message	createMessageInstance(java.lang.String key, java.lang.String secret, RecipientType recipientType, java.lang.String message) Creates an instance of a message object which stores all aspects of the message (from, to-list, receiptwanted, message-content, encoding, sending schedule date, expiry date of the message, udhi )
static Message	createMessageInstance(java.lang.String key, java.lang.String secret, java.lang.String recipientType) Deprecated.
static javax.ws.rs.core.Response	deleteContactFromGroup(java.lang.String key, java.lang.String secret, java.lang.String groupName, java.lang.String contactNumber) Deletes a contact from a group.
static javax.ws.rs.core.Response	deleteGroup(java.lang.String key, java.lang.String secret, java.lang.String groupName) Deletes a group from your SMSJuice account
static javax.ws.rs.core.Response	deleteRecipientRateLimitRule(java.lang.String key, java.lang.String secret) Delete/Reomove recipient rate limit rules
static javax.ws.rs.core.Response	getAllGroupContacts(java.lang.String key, java.lang.String secret, java.lang.String groupName) Gets all contacts in a group
static javax.ws.rs.core.Response	getAllGroups(java.lang.String key, java.lang.String secret) Get a list of all groups from your SMSJuice account
static javax.ws.rs.core.Response	getBalance(java.lang.String key, java.lang.String secret) Gets the balance on your account
static javax.ws.rs.core.Response	getCredit(java.lang.String key, java.lang.String secret) Gets the credits left on your account
static javax.ws.rs.core.Response	getMessageReport(java.lang.String key, java.lang.String secret, java.lang.String messageId) Returns the message status of a message sent.
static javax.ws.rs.core.Response	getTemplate(java.lang.String key, java.lang.String secret, java.lang.String templateId) Get one template stored on your account by its Id
static javax.ws.rs.core.Response	getTemplatesList(java.lang.String key, java.lang.String secret) Get a list of all templates stored for your account
static javax.ws.rs.core.Response	sendMessage(Message message) Sends a message to the server API to be sent to all the recipients listed in the message object

Methods inherited from class java.lang.Object

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

Constructor Detail

TextMessagingService

public TextMessagingService()

Method Detail

createMessageInstance

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

Deprecated.

Creates an instance of a message object which stores all aspects of the message (from, to-list, receiptwanted, message-payload,, encoding, sending schedule date, expiry date of the message, udhi )

Parameters:

key - found from your account settings page

secret - found from your account settings page

Returns:

an instance of Message

Throws:

MessageException

RecipientTypeException

createMessageInstance

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

Creates an instance of a message object which stores all aspects of the message (from, to-list, receiptwanted, encoding, sending schedule date, expiry date of the message, udhi )

Parameters:

key - found from your account settings page

secret - found from your account settings page

recipientType - Type of recipients to which the message will be sent. Groups or numbers

templateId - the template ID of the message (stored on your SMSJuice account) to be sent as the message content to the recipients

Returns:

an instance of Message

Throws:

MessageException

RecipientTypeException

createMessageInstance

public static Message createMessageInstance(java.lang.String key,
                                            java.lang.String secret,
                                            RecipientType recipientType,
                                            java.lang.String message)
                                     throws MessageException

Creates an instance of a message object which stores all aspects of the message (from, to-list, receiptwanted, message-content, encoding, sending schedule date, expiry date of the message, udhi )

Parameters:

key - found from your account settings page

secret - found from your account settings page

recipientType - Type of recipients to which the message will be sent. Groups or numbers

message - The message content to be sent

Returns:

an instance of Message

Throws:

MessageException

RecipientTypeException

createContactGroupInstance

public static ContactGroup createContactGroupInstance(java.lang.String key,
                                                      java.lang.String secret,
                                                      java.lang.String groupName)
                                               throws ContactException

Creates an instance of a group in which you can add contacts

Parameters:

key - found from your account settings page

secret - found from your account settings page

groupName - The name that will be given to the group

Returns:

an instance of the ContactGroup

Throws:

ContactException

sendMessage

public static javax.ws.rs.core.Response sendMessage(Message message)
                                             throws java.io.IOException

Sends a message to the server API to be sent to all the recipients listed in the message object

Parameters:

message - Message object to send

Returns:

A Response object with JSON string response from the server with the result

Throws:

MessageException

java.io.IOException

getMessageReport

public static javax.ws.rs.core.Response getMessageReport(java.lang.String key,
                                                         java.lang.String secret,
                                                         java.lang.String messageId)
                                                  throws java.io.IOException

Returns the message status of a message sent.

Parameters:

key - found from your account settings page

secret - found from your account settings page

messageId - ID of the message that you want to query to see its delivery status or report.

Returns:

A Response object with JSON string with the report on the status of the message

Throws:

java.io.IOException

getBalance

public static javax.ws.rs.core.Response getBalance(java.lang.String key,
                                                   java.lang.String secret)
                                            throws java.io.IOException

Gets the balance on your account

Parameters:

key - found from your account settings page

secret - found from your account settings page

Returns:

A Response object with JSON string response from the server with the result

Throws:

java.io.IOException

getCredit

public static javax.ws.rs.core.Response getCredit(java.lang.String key,
                                                  java.lang.String secret)
                                           throws java.io.IOException

Gets the credits left on your account

Parameters:

key - found from your account settings page

secret - found from your account settings page

Returns:

A Response object with JSON string response from the server with the result

Throws:

java.io.IOException

addNewGroup

public static javax.ws.rs.core.Response addNewGroup(ContactGroup group)
                                             throws ContactException,
                                                    java.io.IOException

Adds a new contact group onto your account as one would add from the SMSJuice web account. It can be empty

Parameters:

group - the ContactGroup to add to your account

Returns:

A Response object with JSON string indicating the success status

Throws:

ContactException

java.io.IOException

addContactsToGroup

public static javax.ws.rs.core.Response addContactsToGroup(ContactGroup group)
                                                    throws ContactException,
                                                           java.io.IOException

Add new contacts to a group of contacts. In a way it's editing a group.

Parameters:

group - groups to add contacts to

Returns:

A Response object with JSON string indicating the success status

Throws:

ContactException

java.io.IOException

getAllGroups

public static javax.ws.rs.core.Response getAllGroups(java.lang.String key,
                                                     java.lang.String secret)
                                              throws java.io.IOException

Get a list of all groups from your SMSJuice account

Parameters:

key - found from your account settings page

secret - found from your account settings page

Returns:

A Response object with JSON string with a list of ALL groups on your account

Throws:

java.io.IOException

getAllGroupContacts

public static javax.ws.rs.core.Response getAllGroupContacts(java.lang.String key,
                                                            java.lang.String secret,
                                                            java.lang.String groupName)
                                                     throws java.io.IOException

Gets all contacts in a group

Parameters:

key - found from your account settings page

secret - found from your account settings page

groupName - the group name whose contacts you want to get

Returns:

A Response object with JSON string of the contacts

Throws:

java.io.IOException

deleteGroup

public static javax.ws.rs.core.Response deleteGroup(java.lang.String key,
                                                    java.lang.String secret,
                                                    java.lang.String groupName)

Deletes a group from your SMSJuice account

Parameters:

key - found from your account settings page

secret - found from your account settings page

groupName - the group name you wish to delete

Returns:

A Response object with JSON string with confirmation of deletion

deleteContactFromGroup

public static javax.ws.rs.core.Response deleteContactFromGroup(java.lang.String key,
                                                               java.lang.String secret,
                                                               java.lang.String groupName,
                                                               java.lang.String contactNumber)

Deletes a contact from a group. Note that at this point you can only delete by numbers, not by names

Parameters:

key - found from your account settings page

secret - found from your account settings page

groupName - the group name you wish to delete the contact from

contactNumber - the number you wish to remove from the group

Returns:

A Response object with JSON string with confirmation of deletion

addNewTemplate

public static javax.ws.rs.core.Response addNewTemplate(MessageTemplate template)
                                                throws TemplateException,
                                                       java.io.IOException

Adds a new canned-message/template for sending to the recipient.

Parameters:

template - the template with the message to add

Returns:

A Response object with JSON string with confirmation of creation

Throws:

ContactException

java.io.IOException

TemplateException

getTemplatesList

public static javax.ws.rs.core.Response getTemplatesList(java.lang.String key,
                                                         java.lang.String secret)

Get a list of all templates stored for your account

Parameters:

key - found from your account settings page

secret - found from your account settings page

Returns:

A Response object with JSON string with all the templates stored on your account

getTemplate

public static javax.ws.rs.core.Response getTemplate(java.lang.String key,
                                                    java.lang.String secret,
                                                    java.lang.String templateId)

Get one template stored on your account by its Id

Parameters:

key - found from your account settings page

secret - found from your account settings page

templateId - ID of the remplate you want to get

Returns:

A Response object with JSON string with the queried template

addRecipientRateLimitRule

public static javax.ws.rs.core.Response addRecipientRateLimitRule(RecipientLimitRule rule)
                                                           throws LimitRuleException,
                                                                  java.io.IOException

Sets a rate limit rule for recipients. There's only ever one maximum rule for this (or zero if not set), so putting a new rule replaces the old one.

Parameters:

rule - Rule object with the rate limit rules

Returns:

A Response object with JSON string with the confirmation of the operation

Throws:

LimitRuleException - Thrown when either of the set rules is less than the numeric value of 1

java.io.IOException

deleteRecipientRateLimitRule

public static javax.ws.rs.core.Response deleteRecipientRateLimitRule(java.lang.String key,
                                                                     java.lang.String secret)

Delete/Reomove recipient rate limit rules

Parameters:

key - found from your account settings page

secret - found from your account settings page

Returns:

A Response object with JSON string with the confirmation of the operation