oneapi.client.impl

Class SMSMessagingClientImpl

java.lang.Object

oneapi.client.impl.OneAPIBaseClientImpl

oneapi.client.impl.SMSMessagingClientImpl

All Implemented Interfaces:

SMSMessagingClient

public class SMSMessagingClientImpl
extends OneAPIBaseClientImpl
implements SMSMessagingClient

Field Summary

Fields inherited from class oneapi.client.impl.OneAPIBaseClientImpl

CHARSET, JSON_CONTENT_TYPE, LOGGER, URL_ENCODED_CONTENT_TYPE

Constructor Summary

Constructors

Constructor and Description
SMSMessagingClientImpl(Configuration configuration)

Method Summary

Modifier and Type	Method and Description
void	addPullDeliveryReportListener(DeliveryReportListener listener) Add OneAPI PULL 'Delivery Reports' listener
void	addPullInboundMessageListener(InboundMessageListener listener) Add OneAPI PULL 'INBOUND Messages' listener Messages are pulled automatically depending on the 'inboundMessagesRetrievingInterval' client configuration parameter
void	addPushDeliveryStatusNotificationListener(DeliveryStatusNotificationsListener listener) Add OneAPI PUSH 'Delivery Status' Notifications listener and start push server simulator
void	addPushInboundMessageListener(InboundMessageNotificationsListener listener) Add OneAPI PUSH 'INBOUND Messages' Notifications listener and start push server simulator
DeliveryInfoNotification	convertJsonToDeliveryInfoNotification(String json) Convert JSON to Delivery Info Notification
InboundSMSMessageList	convertJsonToInboundSMSMessageNotificationExample(String json) Convert JSON to Inbound SMS Message Notification
DeliveryReportSubscription	getDeliveryNotificationsSubscriptionById(String subscriptionId) Get delivery notifications subscriptions by subscription id
DeliveryReportSubscription[]	getDeliveryNotificationsSubscriptions() Get delivery notifications subscriptions by for the current user
DeliveryReportSubscription[]	getDeliveryNotificationsSubscriptionsBySender(String senderAddress) Get delivery notifications subscriptions by sender address
List<DeliveryReportListener>	getDeliveryReportPullListeners() Returns Delivery Reports PULL Listeners list
DeliveryReportList	getDeliveryReports() Get delivery reports
DeliveryReportList	getDeliveryReports(int limit) Get delivery reports
void	getDeliveryReportsAsync(int limit, ResponseListener<DeliveryReportList> responseListener) Get delivery reports asynchronously
void	getDeliveryReportsAsync(ResponseListener<DeliveryReportList> responseListener) Get delivery reports asynchronously
DeliveryReportList	getDeliveryReportsByRequestId(String requestId) Get delivery reports by Request Id
DeliveryReportList	getDeliveryReportsByRequestId(String requestId, int limit) Get delivery reports by Request Id
List<DeliveryStatusNotificationsListener>	getDeliveryStatusNotificationPushListeners() Returns Delivery Status Notifications PUSH Listeners list
List<InboundMessageListener>	getInboundMessagePullListeners() Returns INBOUND Message PULL Listeners list
List<InboundMessageNotificationsListener>	getInboundMessagePushListeners() Returns INBOUND Message Notifications PUSH Listeners list
InboundSMSMessageList	getInboundMessages() Get SMS messages sent to your Web application over OneAPI using default 'maxBatchSize' = 100
InboundSMSMessageList	getInboundMessages(int maxBatchSize) Get SMS messages sent to your Web application over OneAPI
void	getInboundMessagesAsync(int maxBatchSize, ResponseListener<InboundSMSMessageList> responseListener) Get asynchronously SMS messages sent to your Web application over OneAPI
void	getInboundMessagesAsync(ResponseListener<InboundSMSMessageList> responseListener) Get asynchronously SMS messages sent to your Web application over OneAPI
MoSubscription[]	getInboundMessagesNotificationsSubscriptions() Get inbound messages notifications subscriptions for the current user
MoSubscription[]	getInboundMessagesNotificationsSubscriptions(int page, int pageSize) Get inbound messages notifications subscriptions for the current user
MoNumberType[]	getMoNumberTypes() Get MO Number Types
DeliveryInfoList	queryDeliveryStatus(String senderAddress, String requestId) Query the delivery status over OneAPI for an SMS sent to one or more mobile terminals
void	queryDeliveryStatusAsync(String senderAddress, String requestId, ResponseListener<DeliveryInfoList> responseListener) Query the delivery status asynchronously over OneAPI for an SMS sent to one or more mobile terminals
void	removeDeliveryNotificationsSubscription(String subscriptionId) Stop subscribing to delivery status notifications over OneAPI for all your sent SMS
void	removeInboundMessagesSubscription(String subscriptionId) Stop subscribing to message receipt notifications for all your received SMS over OneAPI
void	removePullDeliveryReportListeners() Remove PULL Delivery Reports listeners and stop retriever
void	removePullInboundMessageListeners() Remove PULL INBOUND Messages listeners and stop retriever
void	removePushDeliveryStatusNotificationListeners() Remove PUSH Delivery Reports Notifications listeners and stop server
void	removePushInboundMessageListeners() Remove PUSH Delivery Reports Notifications listeners and stop server
SendMessageResult	sendSMS(SMSRequest smsRequest) Send an SMS over OneAPI to one or more mobile terminals using the customized 'SMSRequest' object
void	sendSMSAsync(SMSRequest smsRequest, ResponseListener<SendMessageResult> responseListener) Send an SMS asynchronously over OneAPI to one or more mobile terminals using the customized 'SMSRequest' object
String	subscribeToDeliveryStatusNotifications(SubscribeToDeliveryNotificationsRequest subscribeToDeliveryNotificationsRequest) Start subscribing to delivery status notifications over OneAPI for all your sent SMS
String	subscribeToInboundMessagesNotifications(SubscribeToInboundMessagesRequest subscribeToInboundMessagesRequest) Start subscribing to notifications of SMS messages sent to your application over OneAPI

Methods inherited from class oneapi.client.impl.OneAPIBaseClientImpl

convertJSONToObject, convertJSONToObject, encodeURLParam, executeMethod, executeMethod, executeMethodAsync, getConfiguration, getIdFromResourceUrl

Methods inherited from class java.lang.Object

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

Constructor Detail

SMSMessagingClientImpl

public SMSMessagingClientImpl(Configuration configuration)

Method Detail

sendSMS

public SendMessageResult sendSMS(SMSRequest smsRequest)

Send an SMS over OneAPI to one or more mobile terminals using the customized 'SMSRequest' object

Specified by:

sendSMS in interface SMSMessagingClient

Parameters:

smsRequest - (mandatory) object containing data needed to be filled in order to send the SMS

Returns:

String Request Id

sendSMSAsync

public void sendSMSAsync(SMSRequest smsRequest,
                         ResponseListener<SendMessageResult> responseListener)

Send an SMS asynchronously over OneAPI to one or more mobile terminals using the customized 'SMSRequest' object

Specified by:

sendSMSAsync in interface SMSMessagingClient

Parameters:

smsRequest - (mandatory) object containing data needed to be filled in order to send the SMS

responseListener - (mandatory) method to call after receiving sent SMS response

queryDeliveryStatus

public DeliveryInfoList queryDeliveryStatus(String senderAddress,
                                            String requestId)

Query the delivery status over OneAPI for an SMS sent to one or more mobile terminals

Specified by:

queryDeliveryStatus in interface SMSMessagingClient

Parameters:

senderAddress - (mandatory) is the address from which SMS messages are being sent. Do not URL encode this value prior to passing to this function

requestId - (mandatory) contains the requestId returned from a previous call to the sendSMS function

Returns:

DeliveryInfoList

queryDeliveryStatusAsync

public void queryDeliveryStatusAsync(String senderAddress,
                                     String requestId,
                                     ResponseListener<DeliveryInfoList> responseListener)

Query the delivery status asynchronously over OneAPI for an SMS sent to one or more mobile terminals

Specified by:

queryDeliveryStatusAsync in interface SMSMessagingClient

Parameters:

senderAddress - (mandatory) is the address from which SMS messages are being sent. Do not URL encode this value prior to passing to this function

requestId - (mandatory) contains the requestId returned from a previous call to the sendSMS function

responseListener - (mandatory) method to call after receiving delivery status

convertJsonToDeliveryInfoNotification

public DeliveryInfoNotification convertJsonToDeliveryInfoNotification(String json)

Convert JSON to Delivery Info Notification

Specified by:

convertJsonToDeliveryInfoNotification in interface SMSMessagingClient

Returns:

DeliveryInfoNotification

subscribeToDeliveryStatusNotifications

public String subscribeToDeliveryStatusNotifications(SubscribeToDeliveryNotificationsRequest subscribeToDeliveryNotificationsRequest)

Start subscribing to delivery status notifications over OneAPI for all your sent SMS

Specified by:

subscribeToDeliveryStatusNotifications in interface SMSMessagingClient

Parameters:

subscribeToDeliveryNotificationsRequest - (mandatory) contains delivery notifications subscription data

Returns:

String Subscription Id

getDeliveryNotificationsSubscriptionsBySender

public DeliveryReportSubscription[] getDeliveryNotificationsSubscriptionsBySender(String senderAddress)

Get delivery notifications subscriptions by sender address

Specified by:

getDeliveryNotificationsSubscriptionsBySender in interface SMSMessagingClient

Returns:

DeliveryReportSubscription[]

getDeliveryNotificationsSubscriptionById

public DeliveryReportSubscription getDeliveryNotificationsSubscriptionById(String subscriptionId)

Get delivery notifications subscriptions by subscription id

Specified by:

getDeliveryNotificationsSubscriptionById in interface SMSMessagingClient

Returns:

DeliveryReportSubscription

getDeliveryNotificationsSubscriptions

public DeliveryReportSubscription[] getDeliveryNotificationsSubscriptions()

Get delivery notifications subscriptions by for the current user

Specified by:

getDeliveryNotificationsSubscriptions in interface SMSMessagingClient

Returns:

DeliveryReportSubscription[]

removeDeliveryNotificationsSubscription

public void removeDeliveryNotificationsSubscription(String subscriptionId)

Stop subscribing to delivery status notifications over OneAPI for all your sent SMS

Specified by:

removeDeliveryNotificationsSubscription in interface SMSMessagingClient

Parameters:

subscriptionId - (mandatory) contains the subscriptionId of a previously created SMS delivery receipt subscription

getInboundMessages

public InboundSMSMessageList getInboundMessages()

Get SMS messages sent to your Web application over OneAPI using default 'maxBatchSize' = 100

Specified by:

getInboundMessages in interface SMSMessagingClient

Returns:

InboundSMSMessageList

getInboundMessages

public InboundSMSMessageList getInboundMessages(int maxBatchSize)

Get SMS messages sent to your Web application over OneAPI

Specified by:

getInboundMessages in interface SMSMessagingClient

Parameters:

maxBatchSize - (optional) is the maximum number of messages to get in this request

Returns:

InboundSMSMessageList

getInboundMessagesAsync

public void getInboundMessagesAsync(ResponseListener<InboundSMSMessageList> responseListener)

Get asynchronously SMS messages sent to your Web application over OneAPI

Specified by:

getInboundMessagesAsync in interface SMSMessagingClient

Parameters:

responseListener - (mandatory) method to call after receiving inbound messages

getInboundMessagesAsync

public void getInboundMessagesAsync(int maxBatchSize,
                                    ResponseListener<InboundSMSMessageList> responseListener)

Get asynchronously SMS messages sent to your Web application over OneAPI

Specified by:

getInboundMessagesAsync in interface SMSMessagingClient

Parameters:

maxBatchSize - (optional) is the maximum number of messages to get in this request

responseListener - (mandatory) method to call after receiving inbound messages

convertJsonToInboundSMSMessageNotificationExample

public InboundSMSMessageList convertJsonToInboundSMSMessageNotificationExample(String json)

Convert JSON to Inbound SMS Message Notification

Specified by:

convertJsonToInboundSMSMessageNotificationExample in interface SMSMessagingClient

Returns:

InboundSMSMessageList

subscribeToInboundMessagesNotifications

public String subscribeToInboundMessagesNotifications(SubscribeToInboundMessagesRequest subscribeToInboundMessagesRequest)

Start subscribing to notifications of SMS messages sent to your application over OneAPI

Specified by:

subscribeToInboundMessagesNotifications in interface SMSMessagingClient

Parameters:

subscribeToInboundMessagesRequest - (mandatory) contains inbound messages subscription data

Returns:

String Subscription Id

getInboundMessagesNotificationsSubscriptions

public MoSubscription[] getInboundMessagesNotificationsSubscriptions(int page,
                                                                     int pageSize)

Get inbound messages notifications subscriptions for the current user

Specified by:

getInboundMessagesNotificationsSubscriptions in interface SMSMessagingClient

Returns:

MoSubscription[]

getInboundMessagesNotificationsSubscriptions

public MoSubscription[] getInboundMessagesNotificationsSubscriptions()

Get inbound messages notifications subscriptions for the current user

Specified by:

getInboundMessagesNotificationsSubscriptions in interface SMSMessagingClient

Returns:

MoSubscription[]

removeInboundMessagesSubscription

public void removeInboundMessagesSubscription(String subscriptionId)

Stop subscribing to message receipt notifications for all your received SMS over OneAPI

Specified by:

removeInboundMessagesSubscription in interface SMSMessagingClient

Parameters:

subscriptionId - (mandatory) contains the subscriptionId of a previously created SMS message receipt subscription

getMoNumberTypes

public MoNumberType[] getMoNumberTypes()

Get MO Number Types

Specified by:

getMoNumberTypes in interface SMSMessagingClient

getDeliveryReports

public DeliveryReportList getDeliveryReports(int limit)

Get delivery reports

Specified by:

getDeliveryReports in interface SMSMessagingClient

Returns:

DeliveryReport[]

getDeliveryReportsAsync

public void getDeliveryReportsAsync(int limit,
                                    ResponseListener<DeliveryReportList> responseListener)

Get delivery reports asynchronously

Specified by:

getDeliveryReportsAsync in interface SMSMessagingClient

Parameters:

responseListener - (mandatory) method to call after receiving delivery reports

getDeliveryReports

public DeliveryReportList getDeliveryReports()

Get delivery reports

Specified by:

getDeliveryReports in interface SMSMessagingClient

Returns:

DeliveryReportList

getDeliveryReportsAsync

public void getDeliveryReportsAsync(ResponseListener<DeliveryReportList> responseListener)

Get delivery reports asynchronously

Specified by:

getDeliveryReportsAsync in interface SMSMessagingClient

Parameters:

responseListener - (mandatory) method to call after receiving delivery reports

getDeliveryReportsByRequestId

public DeliveryReportList getDeliveryReportsByRequestId(String requestId,
                                                        int limit)

Get delivery reports by Request Id

Specified by:

getDeliveryReportsByRequestId in interface SMSMessagingClient

Returns:

DeliveryReportList

getDeliveryReportsByRequestId

public DeliveryReportList getDeliveryReportsByRequestId(String requestId)

Get delivery reports by Request Id

Specified by:

getDeliveryReportsByRequestId in interface SMSMessagingClient

Returns:

DeliveryReportList

addPullDeliveryReportListener

public void addPullDeliveryReportListener(DeliveryReportListener listener)

Add OneAPI PULL 'Delivery Reports' listener

Specified by:

addPullDeliveryReportListener in interface SMSMessagingClient

Parameters:

listener - - (new DeliveryReportListener)

addPullInboundMessageListener

public void addPullInboundMessageListener(InboundMessageListener listener)

Add OneAPI PULL 'INBOUND Messages' listener Messages are pulled automatically depending on the 'inboundMessagesRetrievingInterval' client configuration parameter

Specified by:

addPullInboundMessageListener in interface SMSMessagingClient

Parameters:

listener - - (new InboundMessageListener)

getInboundMessagePullListeners

public List<InboundMessageListener> getInboundMessagePullListeners()

Returns INBOUND Message PULL Listeners list

Specified by:

getInboundMessagePullListeners in interface SMSMessagingClient

getDeliveryReportPullListeners

public List<DeliveryReportListener> getDeliveryReportPullListeners()

Returns Delivery Reports PULL Listeners list

Specified by:

getDeliveryReportPullListeners in interface SMSMessagingClient

removePullDeliveryReportListeners

public void removePullDeliveryReportListeners()

Remove PULL Delivery Reports listeners and stop retriever

Specified by:

removePullDeliveryReportListeners in interface SMSMessagingClient

removePullInboundMessageListeners

public void removePullInboundMessageListeners()

Remove PULL INBOUND Messages listeners and stop retriever

Specified by:

removePullInboundMessageListeners in interface SMSMessagingClient

addPushDeliveryStatusNotificationListener

public void addPushDeliveryStatusNotificationListener(DeliveryStatusNotificationsListener listener)

Add OneAPI PUSH 'Delivery Status' Notifications listener and start push server simulator

Specified by:

addPushDeliveryStatusNotificationListener in interface SMSMessagingClient

addPushInboundMessageListener

public void addPushInboundMessageListener(InboundMessageNotificationsListener listener)

Add OneAPI PUSH 'INBOUND Messages' Notifications listener and start push server simulator

Specified by:

addPushInboundMessageListener in interface SMSMessagingClient

getDeliveryStatusNotificationPushListeners

public List<DeliveryStatusNotificationsListener> getDeliveryStatusNotificationPushListeners()

Returns Delivery Status Notifications PUSH Listeners list

Specified by:

getDeliveryStatusNotificationPushListeners in interface SMSMessagingClient

getInboundMessagePushListeners

public List<InboundMessageNotificationsListener> getInboundMessagePushListeners()

Returns INBOUND Message Notifications PUSH Listeners list

Specified by:

getInboundMessagePushListeners in interface SMSMessagingClient

removePushDeliveryStatusNotificationListeners

public void removePushDeliveryStatusNotificationListeners()

Remove PUSH Delivery Reports Notifications listeners and stop server

Specified by:

removePushDeliveryStatusNotificationListeners in interface SMSMessagingClient

removePushInboundMessageListeners

public void removePushInboundMessageListeners()

Remove PUSH Delivery Reports Notifications listeners and stop server

Specified by:

removePushInboundMessageListeners in interface SMSMessagingClient