Package com.sendly.resources

Class Messages

java.lang.Object

com.sendly.resources.Messages

public class Messages
extends Object

Messages resource for sending and managing SMS.

Constructor Summary

Constructors

Constructor	Description
Messages(Sendly client)

Method Summary

Modifier and Type	Method	Description
CancelScheduledMessageResponse	cancelScheduled(String id)	Cancel a scheduled message.
Iterable<Message>	each()	Iterate over all messages with automatic pagination.
Iterable<Message>	each(ListMessagesRequest request)	Iterate over all messages with automatic pagination.
Message	get(String id)	Get a message by ID.
BatchMessageResponse	getBatch(String batchId)	Get a batch by ID.
ScheduledMessage	getScheduled(String id)	Get a scheduled message by ID.
MessageList	list()	List messages.
MessageList	list(ListMessagesRequest request)	List messages with options.
BatchList	listBatches()	List all batches.
BatchList	listBatches(ListBatchesRequest request)	List batches with options.
ScheduledMessageList	listScheduled()	List scheduled messages.
ScheduledMessageList	listScheduled(ListScheduledMessagesRequest request)	List scheduled messages with options.
ScheduledMessage	schedule(ScheduleMessageRequest request)	Schedule a message for future delivery.
ScheduledMessage	schedule(String to, String text, String scheduledAt)	Schedule a message for future delivery.
Message	send(SendMessageRequest request)	Send an SMS message.
Message	send(String to, String text)	Send an SMS message.
BatchMessageResponse	sendBatch(SendBatchRequest request)	Send a batch of messages.

Methods inherited from class java.lang.Object

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

Constructor Details

Messages

public Messages(Sendly client)

Method Details

send

public Message send(String to,
 String text)
             throws SendlyException

Send an SMS message.

Parameters:

to - Recipient phone number in E.164 format

text - Message content

Returns:

The sent message

Throws:

SendlyException - if the request fails

send

public Message send(SendMessageRequest request)
             throws SendlyException

Send an SMS message.

Parameters:

request - Send message request

Returns:

The sent message

Throws:

SendlyException - if the request fails

list

public MessageList list()
                 throws SendlyException

List messages.

Returns:

List of messages

Throws:

SendlyException - if the request fails

list

public MessageList list(ListMessagesRequest request)
                 throws SendlyException

List messages with options.

Parameters:

request - List options

Returns:

List of messages

Throws:

SendlyException - if the request fails

get

public Message get(String id)
            throws SendlyException

Get a message by ID.

Parameters:

id - Message ID

Returns:

The message

Throws:

SendlyException - if the request fails

each

public Iterable<Message> each()

Iterate over all messages with automatic pagination.

Returns:

Iterable over all messages

each

public Iterable<Message> each(ListMessagesRequest request)

Iterate over all messages with automatic pagination.

Parameters:

request - List options (status, to filters)

Returns:

Iterable over all messages

schedule

public ScheduledMessage schedule(String to,
 String text,
 String scheduledAt)
                          throws SendlyException

Schedule a message for future delivery.

Parameters:

to - Recipient phone number in E.164 format

text - Message content

scheduledAt - ISO 8601 datetime (must be at least 1 minute in the future)

Returns:

The scheduled message

Throws:

SendlyException - if the request fails

schedule

public ScheduledMessage schedule(ScheduleMessageRequest request)
                          throws SendlyException

Schedule a message for future delivery.

Parameters:

request - Schedule message request

Returns:

The scheduled message

Throws:

SendlyException - if the request fails

listScheduled

public ScheduledMessageList listScheduled()
                                   throws SendlyException

List scheduled messages.

Returns:

List of scheduled messages

Throws:

SendlyException - if the request fails

listScheduled

public ScheduledMessageList listScheduled(ListScheduledMessagesRequest request)
                                   throws SendlyException

List scheduled messages with options.

Parameters:

request - List options

Returns:

List of scheduled messages

Throws:

SendlyException - if the request fails

getScheduled

public ScheduledMessage getScheduled(String id)
                              throws SendlyException

Get a scheduled message by ID.

Parameters:

id - Scheduled message ID

Returns:

The scheduled message

Throws:

SendlyException - if the request fails

cancelScheduled

public CancelScheduledMessageResponse cancelScheduled(String id)
                                               throws SendlyException

Cancel a scheduled message.

Parameters:

id - Scheduled message ID

Returns:

The cancellation response with refunded credits

Throws:

SendlyException - if the request fails

sendBatch

public BatchMessageResponse sendBatch(SendBatchRequest request)
                               throws SendlyException

Send a batch of messages.

Parameters:

request - Batch send request

Returns:

The batch response with results

Throws:

SendlyException - if the request fails

getBatch

public BatchMessageResponse getBatch(String batchId)
                              throws SendlyException

Get a batch by ID.

Parameters:

batchId - Batch ID

Returns:

The batch response

Throws:

SendlyException - if the request fails

listBatches

public BatchList listBatches()
                      throws SendlyException

List all batches.

Returns:

List of batches

Throws:

SendlyException - if the request fails

listBatches

public BatchList listBatches(ListBatchesRequest request)
                      throws SendlyException

List batches with options.

Parameters:

request - List options

Returns:

List of batches

Throws:

SendlyException - if the request fails