Package | Description |
---|---|
com.clxcommunications.xms |
This package contains a Java interface for the CLX Communications XMS API.
|
Modifier and Type | Class and Description |
---|---|
class |
ConcurrentException
An exception that wraps checked exceptions.
|
class |
ErrorResponseException
Exception representing an error response from XMS.
|
class |
NotFoundException
Exception thrown when an API connection receives a 404 response from the REST
API.
|
class |
UnauthorizedException
Exception indicating that the service plan ID and authentication token were
invalid.
|
class |
UnexpectedResponseException
Exception thrown when an API connection receives a response from the REST API
that is neither a success response nor an API level error.
|
Modifier and Type | Method and Description |
---|---|
MtBatchSmsResult |
ApiConnection.cancelBatch(BatchId batchId)
Cancels the batch with the given batch ID.
|
MtBatchBinarySmsResult |
ApiConnection.createBatch(MtBatchBinarySmsCreate sms)
Creates the given batch and schedules it for submission.
|
MtBatchTextSmsResult |
ApiConnection.createBatch(MtBatchTextSmsCreate sms)
Creates the given batch and schedules it for submission.
|
MtBatchDryRunResult |
ApiConnection.createBatchDryRun(MtBatchSmsCreate sms,
Boolean perRecipient,
Integer numRecipients)
Attempts to perform a dry run of the given batch.
|
GroupResult |
ApiConnection.createGroup(GroupCreate group)
Attempts to create the given group synchronously.
|
void |
ApiConnection.deleteGroup(GroupId id)
Deletes the given group.
|
MtBatchSmsResult |
ApiConnection.fetchBatch(BatchId id)
Fetches the given batch.
|
BatchDeliveryReport |
ApiConnection.fetchDeliveryReport(BatchId id,
BatchDeliveryReportParams filter)
Fetches a delivery report for the batch with the given batch ID.
|
RecipientDeliveryReport |
ApiConnection.fetchDeliveryReport(BatchId id,
String recipient)
Fetches a delivery report for the batch with the given batch ID and
recipient.
|
GroupResult |
ApiConnection.fetchGroup(GroupId id)
Attempts to fetch the given group.
|
Set<String> |
ApiConnection.fetchGroupMembers(GroupId id)
Attempts to fetch the members of the given group synchronously.
|
MoSms |
ApiConnection.fetchInbound(String id)
Fetches the inbound message having the given identifier.
|
Tags |
ApiConnection.fetchTags(BatchId id)
Fetches the tags of the batch with the given batch ID.
|
Tags |
ApiConnection.fetchTags(GroupId id)
Fetches the tags of the group with the given identifier.
|
MtBatchBinarySmsResult |
ApiConnection.replaceBatch(BatchId id,
MtBatchBinarySmsCreate sms)
Replaces the batch with the given identifier.
|
MtBatchTextSmsResult |
ApiConnection.replaceBatch(BatchId id,
MtBatchTextSmsCreate sms)
Replaces the batch with the given identifier.
|
GroupResult |
ApiConnection.replaceGroup(GroupId id,
GroupCreate group)
Replaces the given group.
|
Tags |
ApiConnection.replaceTags(BatchId id,
Tags tags)
Replaces the tags of the batch with the given batch ID.
|
Tags |
ApiConnection.replaceTags(GroupId id,
Tags tags)
Replaces the tags of the group with the given identifier.
|
MtBatchBinarySmsResult |
ApiConnection.updateBatch(BatchId id,
MtBatchBinarySmsUpdate sms)
Updates the given binary batch.
|
MtBatchTextSmsResult |
ApiConnection.updateBatch(BatchId id,
MtBatchTextSmsUpdate sms)
Updates the given text batch.
|
GroupResult |
ApiConnection.updateGroup(GroupId id,
GroupUpdate group)
Updates the given group.
|
Tags |
ApiConnection.updateTags(BatchId id,
TagsUpdate tags)
Updates the tags of the batch with the given batch ID.
|
Tags |
ApiConnection.updateTags(GroupId id,
TagsUpdate tags)
Updates the tags of the group with the given identifier.
|
Constructor and Description |
---|
RuntimeApiException(ApiException e)
Constructs a new runtime API exception wrapping the given API exception.
|
Copyright © 2016–2019 CLX Communications. All rights reserved.