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 java.lang.String	addContactsToGroup(ContactGroup group) Add new contacts to a group of contacts.
static java.lang.String	addNewGroup(ContactGroup group) Adds a new contact group onto your account as one would add from the SMSJuice web account.
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, java.lang.String recipientType) 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 )
static java.lang.String	deleteContactFromGroup(java.lang.String key, java.lang.String secret, java.lang.String groupName, java.lang.String contactNumber) Deletes a contact from a group.
static java.lang.String	deleteGroup(java.lang.String key, java.lang.String secret, java.lang.String groupName) Deletes a group from your SMSJuice account
static java.lang.String	getAllGroupContacts(java.lang.String key, java.lang.String secret, java.lang.String groupName) Gets all contacts in a group
static java.lang.String	getAllGroups(java.lang.String key, java.lang.String secret) Get a list of all groups from your SMSJuice account
static java.lang.String	getBalance(java.lang.String key, java.lang.String secret) Gets the balance on your account
static java.lang.String	getCredit(java.lang.String key, java.lang.String secret) Gets the credits left on your account
static java.lang.String	getMessageReport(java.lang.String key, java.lang.String secret, java.lang.String messageId) Returns the message status of a message sent.
static java.lang.String	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

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

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 java.lang.String sendMessage(Message message)
                                    throws MessageException,
                                           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 JSON string response from the server with the result

Throws:

MessageException

java.io.IOException

getMessageReport

public static java.lang.String 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 JSON string with the report on the status of the message

Throws:

java.io.IOException

getBalance

public static java.lang.String 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 JSON string response from the server with the result

Throws:

java.io.IOException

getCredit

public static java.lang.String 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 JSON string response from the server with the result

Throws:

java.io.IOException

addNewGroup

public static java.lang.String 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:

JSON string indicating the success status

Throws:

ContactException

java.io.IOException

addContactsToGroup

public static java.lang.String 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:

JSON string indicating the success status

Throws:

ContactException

java.io.IOException

getAllGroups

public static java.lang.String 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:

JSON string with a list of ALL groups on your account

Throws:

java.io.IOException

getAllGroupContacts

public static java.lang.String 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:

JSON string of the contacts

Throws:

java.io.IOException

deleteGroup

public static java.lang.String 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:

JSON String with confirmation of deletion

deleteContactFromGroup

public static java.lang.String 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:

JSON String with confirmation of deletion