public class ElibomRestClient extends Object
| Constructor and Description |
|---|
ElibomRestClient(String username,
String apiPassword)
Initializes the client with the supplied
username and apiPassword. |
ElibomRestClient(String username,
String apiPassword,
String host)
Mostly used for testing.
|
| Modifier and Type | Method and Description |
|---|---|
Account |
getAccount()
Query your account info.
|
Delivery |
getDelivery(String deliveryId)
Query the delivery with the specified
deliveryId. |
List<Message> |
getLastMessages(int numMessages)
Query the last
numMessages messages sent from an user |
List<Message> |
getLastMessages(int numMessages,
Date startDate,
Date endDate)
Query the last
numMessages messages sent from an user between two dates |
Schedule |
getScheduledMessage(long id)
Query the scheduled message with the specified id.
|
List<Schedule> |
getScheduledMessages()
Query the scheduled messages.
|
User |
getUser(long id)
Query a single account user.
|
List<User> |
getUsers()
Query your account users (those who have access to the account).
|
long |
scheduleMessage(String to,
String text,
Date scheduleDate)
Schedules an SMS message for the specified
scheduleDate to one or more destinations and with the specified
text. |
long |
scheduleMessage(String to,
String text,
Date scheduleDate,
String campaign)
Schedules an SMS message for the specified
scheduleDate to one or more destinations and with the specified
text and a campaign id. |
String |
sendMessage(String to,
String text)
Sends an SMS message to one or more destinations with the specified
text. |
String |
sendMessage(String to,
String text,
String campaign)
Sends an SMS message to one or more destinations with the specified
text and a campaign id. |
void |
unschedule(long id)
Cancels the scheduled message with the specified
id. |
public ElibomRestClient(String username, String apiPassword)
username and apiPassword.username - the email you use to access your account at elibom.com.apiPassword - your API password, which can be found in the settings section of your account.public ElibomRestClient(String username, String apiPassword, String host)
username, apiPassword and
host. Mostly used for testing.username - the email you use to access your account at elibom.com.apiPassword - your API password, which you can find in the settings of your account.host - the host to which the requests are going to be made.public String sendMessage(String to, String text) throws HttpServerException, RuntimeException
text.to - the destinations (separated by comma) to which you want to send the SMS message.text - the text of the SMS message, max 160 characters.getDelivery(String) method).HttpServerException - if the server responds with a HTTP status code other than 200 OK.RuntimeException - wraps any other unexpected exception.public String sendMessage(String to, String text, String campaign) throws HttpServerException, RuntimeException
text and a campaign id.to - the destinations (separated by comma) to which you want to send the SMS message.text - the text of the SMS message, max 160 characters.campaing - an id to identified a group of messages.getDelivery(String) method).HttpServerException - if the server responds with a HTTP status code other than 200 OK.RuntimeException - wraps any other unexpected exception.public long scheduleMessage(String to, String text, Date scheduleDate) throws HttpServerException, RuntimeException
scheduleDate to one or more destinations and with the specified
text.to - the destinations (separated by comma) to which we are going to send the scheduled SMS message.text - the text of the SMS message, max 160 characters.scheduleDate - the date in which the message is going to be sent.#getSchedule(long) method.HttpServerException - if the server responds with a HTTP status code other than 200 OK.RuntimeException - wraps any other unexpected exception.public long scheduleMessage(String to, String text, Date scheduleDate, String campaign) throws HttpServerException, RuntimeException
scheduleDate to one or more destinations and with the specified
text and a campaign id.to - the destinations (separated by comma) to which we are going to send the scheduled SMS message.text - the text of the SMS message, max 160 characters.scheduleDate - the date in which the message is going to be sent.campaing - an id to identified a group of messages.#getSchedule(long) method.HttpServerException - if the server responds with a HTTP status code other than 200 OK.RuntimeException - wraps any other unexpected exception.public List<Message> getLastMessages(int numMessages) throws HttpServerException, RuntimeException
numMessages messages sent from an usernumMessages - number of messages that will be consultedHttpServerException - if the server responds with a HTTP status code other than 200 OK.RuntimeException - wraps any other unexpected exception.public List<Message> getLastMessages(int numMessages, Date startDate, Date endDate) throws HttpServerException, RuntimeException
numMessages messages sent from an user between two datesnumMessages - number of messages that will be consultedstartDate - the initial date from the reportendDate - the end date from the reportHttpServerException - if the server responds with a HTTP status code other than 200 OK.RuntimeException - wraps any other unexpected exception.public Delivery getDelivery(String deliveryId) throws HttpServerException, RuntimeException
deliveryId.deliveryId - HttpServerException - if the server responds with a HTTP status code other than 200 OK.RuntimeException - wraps any other unexpected exception.public List<Schedule> getScheduledMessages() throws HttpServerException, RuntimeException
HttpServerException - if the server responds with a HTTP status code other than 200 OK.RuntimeException - wraps any other unexpected exception.public Schedule getScheduledMessage(long id) throws HttpServerException, RuntimeException
id - the id of the scheduled message to query.HttpServerException - if the server responds with a HTTP status code other than 200 OK.RuntimeException - wraps any other unexpected exception.public void unschedule(long id)
throws HttpServerException,
RuntimeException
id.id - the id of the schedule to be canceled.HttpServerException - if the server responds with a HTTP status code other than 200 OK.RuntimeException - wraps any other unexpected exception.public List<User> getUsers() throws HttpServerException, RuntimeException
HttpServerException - if the server responds with a HTTP status code other than 200 OK.RuntimeException - wraps any other unexpected exception.public User getUser(long id) throws HttpServerException, RuntimeException
id - the id of the account user to query.HttpServerException - if the server responds with a HTTP status code other than 200 OK.RuntimeException - wraps any other unexpected exception.public Account getAccount() throws HttpServerException, RuntimeException
HttpServerException - if the server responds with a HTTP status code other than 200 OK.RuntimeException - wraps any other unexpected exception.Copyright © 2016. All rights reserved.