Package com.vonage.client.sms

Class SmsClient

java.lang.Object

com.vonage.client.sms.SmsClient

public class SmsClient
extends java.lang.Object

A client for talking to the Vonage Voice API. The standard way to obtain an instance of this class is to use VonageClient.getSmsClient().

Constructor Summary

Constructors

Constructor	Description
SmsClient(HttpWrapper httpWrapper)	Create a new SmsClient.

Method Summary

Modifier and Type	Method	Description
SmsSingleSearchResponse	getSms(java.lang.String id)	Search for a single SMS by id.
SearchSmsResponse	searchMessages(SearchSmsRequest request)	Search for completed SMS transactions.
SearchSmsResponse	searchMessages(java.lang.String id, java.lang.String... ids)	Search for completed SMS transactions by ID
SearchSmsResponse	searchMessages(java.util.Date date, java.lang.String to)	Search for completed SMS transactions by date and recipient MSISDN.
SearchRejectedMessagesResponse	searchRejectedMessages(SearchRejectedMessagesRequest request)	Search for rejected SMS transactions using a SearchRejectedMessagesRequest.
SearchRejectedMessagesResponse	searchRejectedMessages(java.util.Date date, java.lang.String to)	Search for rejected SMS transactions by date and recipient MSISDN.
SmsSubmissionResponse	submitMessage(Message message)	Send an SMS message.

Methods inherited from class java.lang.Object

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

Constructor Details

SmsClient

public SmsClient(HttpWrapper httpWrapper)

Create a new SmsClient.

Method Details

submitMessage

public SmsSubmissionResponse submitMessage(Message message) throws VonageResponseParseException, VonageClientException

Send an SMS message.

This uses the supplied object to construct a request and post it to the Vonage API.
This method will respond with an SmsSubmissionResponse object. Depending on the nature and length of the submitted message, Vonage may automatically split the message into multiple sms messages in order to deliver to the handset. For example, a long text sms of greater than 160 chars will need to be split into multiple 'concatenated' sms messages. The Vonage service will handle this automatically for you.
The messages are stored as a Collection of SmsSubmissionResponseMessage objects on the SmsSubmissionResponse object. Each message can potentially have a different status result, and each message will have a different message id. Delivery notifications will be generated for each sms message within this set and will be posted to your application containing the appropriate message id.

Parameters:

message - The message request object that describes the type of message and the contents to be submitted.

Returns:

SmsSubmissionResponse an object containing a collection of SmsSubmissionResponseMessage objects for each actual sms that was required to submit the message.

Throws:

VonageClientException - if there was a problem with the Vonage request or response objects.

VonageResponseParseException - if the response from the API could not be parsed.

searchMessages

public SearchSmsResponse searchMessages(SearchSmsRequest request) throws VonageResponseParseException, VonageClientException

Search for completed SMS transactions.

You should probably use the helper methods searchMessages(String, String...) or searchMessages(String, String...) instead.

Throws:

VonageClientException - if there was a problem with the Vonage request or response objects.

VonageResponseParseException - if the response from the API could not be parsed.

searchMessages

public SearchSmsResponse searchMessages(java.lang.String id, java.lang.String... ids) throws VonageResponseParseException, VonageClientException

Search for completed SMS transactions by ID

Parameters:

id - the first ID to look up

ids - optional extra IDs to look up

Returns:

SMS data matching the provided criteria.

Throws:

VonageClientException - if there was a problem with the Vonage request or response objects.

VonageResponseParseException - if the response from the API could not be parsed.

searchMessages

public SearchSmsResponse searchMessages(java.util.Date date, java.lang.String to) throws VonageResponseParseException, VonageClientException

Search for completed SMS transactions by date and recipient MSISDN.

Parameters:

date - the date of the SMS message to be looked up

to - the MSISDN number of the SMS recipient

Returns:

SMS data matching the provided criteria

Throws:

VonageClientException - if there was a problem with the Vonage request or response objects.

VonageResponseParseException - if the response from the API could not be parsed.

searchRejectedMessages

public SearchRejectedMessagesResponse searchRejectedMessages(SearchRejectedMessagesRequest request) throws VonageResponseParseException, VonageClientException

Search for rejected SMS transactions using a SearchRejectedMessagesRequest.

You should probably use searchRejectedMessages(Date, String) instead.

Returns:

rejection data matching the provided criteria

Throws:

VonageClientException - if there was a problem with the Vonage request or response objects.

VonageResponseParseException - if the response from the API could not be parsed.

searchRejectedMessages

public SearchRejectedMessagesResponse searchRejectedMessages(java.util.Date date, java.lang.String to) throws VonageResponseParseException, VonageClientException

Search for rejected SMS transactions by date and recipient MSISDN.

Parameters:

date - the date of the rejected SMS message to be looked up

to - the MSISDN number of the SMS recipient

Returns:

rejection data matching the provided criteria

Throws:

VonageClientException - if there was a problem with the Vonage request or response objects.

VonageResponseParseException - if the response from the API could not be parsed.

getSms

public SmsSingleSearchResponse getSms(java.lang.String id) throws VonageResponseParseException, VonageClientException

Search for a single SMS by id.

Parameters:

id - The message id to search for.

Returns:

SmsSingleSearchResponse object containing the details of the SMS.

Throws:

VonageClientException - if there was a problem with the Vonage request or response objects.

VonageResponseParseException - if the response from the API could not be parsed.