Package com.sendly.resources
Class Messages
java.lang.Object
com.sendly.resources.Messages
Messages resource for sending and managing SMS.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionCancel a scheduled message.each()Iterate over all messages with automatic pagination.each(ListMessagesRequest request) Iterate over all messages with automatic pagination.Get a message by ID.Get a batch by ID.getScheduled(String id) Get a scheduled message by ID.list()List messages.list(ListMessagesRequest request) List messages with options.List all batches.listBatches(ListBatchesRequest request) List batches with options.List scheduled messages.List scheduled messages with options.schedule(ScheduleMessageRequest request) Schedule a message for future delivery.Schedule a message for future delivery.send(SendMessageRequest request) Send an SMS message.Send an SMS message.sendBatch(SendBatchRequest request) Send a batch of messages.
-
Constructor Details
-
Messages
-
-
Method Details
-
send
Send an SMS message.- Parameters:
to- Recipient phone number in E.164 formattext- Message content- Returns:
- The sent message
- Throws:
SendlyException- if the request fails
-
send
Send an SMS message.- Parameters:
request- Send message request- Returns:
- The sent message
- Throws:
SendlyException- if the request fails
-
list
List messages.- Returns:
- List of messages
- Throws:
SendlyException- if the request fails
-
list
List messages with options.- Parameters:
request- List options- Returns:
- List of messages
- Throws:
SendlyException- if the request fails
-
get
Get a message by ID.- Parameters:
id- Message ID- Returns:
- The message
- Throws:
SendlyException- if the request fails
-
each
Iterate over all messages with automatic pagination.- Returns:
- Iterable over all messages
-
each
Iterate over all messages with automatic pagination.- Parameters:
request- List options (status, to filters)- Returns:
- Iterable over all messages
-
schedule
Schedule a message for future delivery.- Parameters:
to- Recipient phone number in E.164 formattext- Message contentscheduledAt- ISO 8601 datetime (must be at least 1 minute in the future)- Returns:
- The scheduled message
- Throws:
SendlyException- if the request fails
-
schedule
Schedule a message for future delivery.- Parameters:
request- Schedule message request- Returns:
- The scheduled message
- Throws:
SendlyException- if the request fails
-
listScheduled
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
Get a scheduled message by ID.- Parameters:
id- Scheduled message ID- Returns:
- The scheduled message
- Throws:
SendlyException- if the request fails
-
cancelScheduled
Cancel a scheduled message.- Parameters:
id- Scheduled message ID- Returns:
- The cancellation response with refunded credits
- Throws:
SendlyException- if the request fails
-
sendBatch
Send a batch of messages.- Parameters:
request- Batch send request- Returns:
- The batch response with results
- Throws:
SendlyException- if the request fails
-
getBatch
Get a batch by ID.- Parameters:
batchId- Batch ID- Returns:
- The batch response
- Throws:
SendlyException- if the request fails
-
listBatches
List all batches.- Returns:
- List of batches
- Throws:
SendlyException- if the request fails
-
listBatches
List batches with options.- Parameters:
request- List options- Returns:
- List of batches
- Throws:
SendlyException- if the request fails
-