SMSMessagingClient (Infobip OneAPI Client 0.0.1 API)

All Known Implementing Classes:

SMSMessagingClientImpl
```
public interface SMSMessagingClient
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addPullDeliveryReportListener(DeliveryReportListener listener)` Add 'Delivery Reports' listener.
`void`	`addPullInboundMessageListener(InboundMessageListener listener)` Add 'INBOUND Messages' listener
`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)` Retrieve delivery notifications subscriptions by subscription id
`DeliveryReportSubscription[]`	`getDeliveryNotificationsSubscriptions()` Retrieve delivery notifications subscriptions by for the current user
`DeliveryReportSubscription[]`	`getDeliveryNotificationsSubscriptionsBySender(String senderAddress)` Retrieve delivery notifications subscriptions by sender address
`List<DeliveryReportListener>`	`getDeliveryReportPullListeners()` Returns Delivery Reports Listeners list
`DeliveryReportList`	`getDeliveryReports()` Retrieve delivery reports
`DeliveryReportList`	`getDeliveryReports(int limit)` Retrieve 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)` Retrieve delivery reports by Request Id
`DeliveryReportList`	`getDeliveryReportsByRequestId(String requestId, int limit)` Retrieve delivery reports by Request Id
`List<DeliveryStatusNotificationsListener>`	`getDeliveryStatusNotificationPushListeners()` Returns Delivery Status Notifications PUSH Listeners list
`List<InboundMessageListener>`	`getInboundMessagePullListeners()` Returns INBOUND Message Listeners list
`List<InboundMessageNotificationsListener>`	`getInboundMessagePushListeners()` Returns INBOUND Message Notifications PUSH Listeners list
`InboundSMSMessageList`	`getInboundMessages()` Retrieve SMS messages sent to your Web application over OneAPI
`InboundSMSMessageList`	`getInboundMessages(int maxBatchSize)` Retrieve SMS messages sent to your Web application
`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()` Retrieve inbound messages notifications subscriptions for the current user (Default values are used: page=1, pageSize=10)
`MoSubscription[]`	`getInboundMessagesNotificationsSubscriptions(int page, int pageSize)` Retrieve inbound messages notifications subscriptions for the current user
`MoNumberType[]`	`getMoNumberTypes()` Get MO Number Types
`DeliveryInfoList`	`queryDeliveryStatus(String senderAddress, String requestId)` Query the delivery status 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 for all your sent SMS
`void`	`removeInboundMessagesSubscription(String subscriptionId)` Stop subscribing to message receipt notifications for all your received SMS
`void`	`removePullDeliveryReportListeners()` Remove Delivery Reports listeners and stop retriever
`void`	`removePullInboundMessageListeners()` Remove 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 sms)` Send an SMS 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

- Method Detail
  - sendSMS
```
SendMessageResult sendSMS(SMSRequest sms)
```
    Send an SMS to one or more mobile terminals using the customized 'SMSRequest' object
    
    Parameters:
    
    sms - - object containing data needed to be filled in order to send the SMS
    
    Returns:
    
    String Request Id
  - sendSMSAsync
```
void sendSMSAsync(SMSRequest smsRequest,
                  ResponseListener<SendMessageResult> responseListener)
```
    Send an SMS asynchronously over OneAPI to one or more mobile terminals using the customized 'SMSRequest' object
    
    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
```
DeliveryInfoList queryDeliveryStatus(String senderAddress,
                                     String requestId)
```
    Query the delivery status for an SMS sent to one or more mobile terminals
    
    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
```
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
    
    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
```
DeliveryInfoNotification convertJsonToDeliveryInfoNotification(String json)
```
    Convert JSON to Delivery Info Notification
    
    Returns:
    
    DeliveryInfoNotification
  - subscribeToDeliveryStatusNotifications
```
String subscribeToDeliveryStatusNotifications(SubscribeToDeliveryNotificationsRequest subscribeToDeliveryNotificationsRequest)
```
    Start subscribing to delivery status notifications over OneAPI for all your sent SMS
    
    Returns:
    
    String Subscription Id
  - getDeliveryNotificationsSubscriptionsBySender
```
DeliveryReportSubscription[] getDeliveryNotificationsSubscriptionsBySender(String senderAddress)
```
    Retrieve delivery notifications subscriptions by sender address
    
    Returns:
    
    DeliveryReportSubscription[]
  - getDeliveryNotificationsSubscriptionById
```
DeliveryReportSubscription getDeliveryNotificationsSubscriptionById(String subscriptionId)
```
    Retrieve delivery notifications subscriptions by subscription id
    
    Returns:
    
    DeliveryReportSubscription
  - getDeliveryNotificationsSubscriptions
```
DeliveryReportSubscription[] getDeliveryNotificationsSubscriptions()
```
    Retrieve delivery notifications subscriptions by for the current user
    
    Returns:
    
    DeliveryReportSubscription[]
  - removeDeliveryNotificationsSubscription
```
void removeDeliveryNotificationsSubscription(String subscriptionId)
```
    Stop subscribing to delivery status notifications for all your sent SMS
    
    Parameters:
    
    subscriptionId - (mandatory) contains the subscriptionId of a previously created SMS delivery receipt subscription
  - getInboundMessages
```
InboundSMSMessageList getInboundMessages()
```
    Retrieve SMS messages sent to your Web application over OneAPI
    
    Returns:
    
    InboundSMSMessageList
  - getInboundMessages
```
InboundSMSMessageList getInboundMessages(int maxBatchSize)
```
    Retrieve SMS messages sent to your Web application
    
    Parameters:
    
    maxBatchSize - (mandatory) is the maximum number of messages to get in this request
    
    Returns:
    
    InboundSMSMessageList
  - getInboundMessagesAsync
```
void getInboundMessagesAsync(ResponseListener<InboundSMSMessageList> responseListener)
```
    Get asynchronously SMS messages sent to your Web application over OneAPI
    
    Parameters:
    
    responseListener - (mandatory) method to call after receiving inbound messages
  - getInboundMessagesAsync
```
void getInboundMessagesAsync(int maxBatchSize,
                             ResponseListener<InboundSMSMessageList> responseListener)
```
    Get asynchronously SMS messages sent to your Web application over OneAPI
    
    Parameters:
    
    maxBatchSize - (optional) is the maximum number of messages to get in this request
    
    responseListener - (mandatory) method to call after receiving inbound messages
  - convertJsonToInboundSMSMessageNotificationExample
```
InboundSMSMessageList convertJsonToInboundSMSMessageNotificationExample(String json)
```
    Convert JSON to Inbound SMS Message Notification
    
    Returns:
    
    InboundSMSMessageList
  - subscribeToInboundMessagesNotifications
```
String subscribeToInboundMessagesNotifications(SubscribeToInboundMessagesRequest subscribeToInboundMessagesRequest)
```
    Start subscribing to notifications of SMS messages sent to your application over OneAPI
    
    Parameters:
    
    subscribeToInboundMessagesRequest - (mandatory) contains inbound messages subscription data
    
    Returns:
    
    string - Subscription Id
  - getInboundMessagesNotificationsSubscriptions
```
MoSubscription[] getInboundMessagesNotificationsSubscriptions(int page,
                                                              int pageSize)
```
    Retrieve inbound messages notifications subscriptions for the current user
    
    Returns:
    
    MoSubscription[]
  - getInboundMessagesNotificationsSubscriptions
```
MoSubscription[] getInboundMessagesNotificationsSubscriptions()
```
    Retrieve inbound messages notifications subscriptions for the current user (Default values are used: page=1, pageSize=10)
    
    Returns:
    
    MoSubscription[]
  - removeInboundMessagesSubscription
```
void removeInboundMessagesSubscription(String subscriptionId)
```
    Stop subscribing to message receipt notifications for all your received SMS
    
    Parameters:
    
    subscriptionId - (mandatory) contains the subscriptionId of a previously created SMS message receipt subscription
  - getMoNumberTypes
```
MoNumberType[] getMoNumberTypes()
```
    Get MO Number Types
  - getDeliveryReports
```
DeliveryReportList getDeliveryReports(int limit)
```
    Retrieve delivery reports
    
    Returns:
    
    DeliveryReportList
  - getDeliveryReportsAsync
```
void getDeliveryReportsAsync(int limit,
                             ResponseListener<DeliveryReportList> responseListener)
```
    Get delivery reports asynchronously
    
    Parameters:
    
    responseListener - (mandatory) method to call after receiving delivery reports
  - getDeliveryReports
```
DeliveryReportList getDeliveryReports()
```
    Retrieve delivery reports
    
    Returns:
    
    DeliveryReportList
  - getDeliveryReportsAsync
```
void getDeliveryReportsAsync(ResponseListener<DeliveryReportList> responseListener)
```
    Get delivery reports asynchronously
    
    Parameters:
    
    responseListener - (mandatory) method to call after receiving delivery reports
  - getDeliveryReportsByRequestId
```
DeliveryReportList getDeliveryReportsByRequestId(String requestId,
                                                 int limit)
```
    Retrieve delivery reports by Request Id
    
    Returns:
    
    DeliveryReportList
  - getDeliveryReportsByRequestId
```
DeliveryReportList getDeliveryReportsByRequestId(String requestId)
```
    Retrieve delivery reports by Request Id
    
    Returns:
    
    DeliveryReportList
  - addPullInboundMessageListener
```
void addPullInboundMessageListener(InboundMessageListener listener)
```
    Add 'INBOUND Messages' listener
    
    Parameters:
    
    listener - - (new InboundMessageListener)
  - addPullDeliveryReportListener
```
void addPullDeliveryReportListener(DeliveryReportListener listener)
```
    Add 'Delivery Reports' listener.
    
    Parameters:
    
    listener - - (new DeliveryReportListener)
  - getInboundMessagePullListeners
```
List<InboundMessageListener> getInboundMessagePullListeners()
```
    Returns INBOUND Message Listeners list
  - getDeliveryReportPullListeners
```
List<DeliveryReportListener> getDeliveryReportPullListeners()
```
    Returns Delivery Reports Listeners list
  - removePullDeliveryReportListeners
```
void removePullDeliveryReportListeners()
```
    Remove Delivery Reports listeners and stop retriever
  - removePullInboundMessageListeners
```
void removePullInboundMessageListeners()
```
    Remove INBOUND Messages listeners and stop retriever
  - addPushDeliveryStatusNotificationListener
```
void addPushDeliveryStatusNotificationListener(DeliveryStatusNotificationsListener listener)
```
    Add OneAPI PUSH 'Delivery Status' Notifications listener and start push server simulator
  - addPushInboundMessageListener
```
void addPushInboundMessageListener(InboundMessageNotificationsListener listener)
```
    Add OneAPI PUSH 'INBOUND Messages' Notifications listener and start push server simulator
  - getDeliveryStatusNotificationPushListeners
```
List<DeliveryStatusNotificationsListener> getDeliveryStatusNotificationPushListeners()
```
    Returns Delivery Status Notifications PUSH Listeners list
  - getInboundMessagePushListeners
```
List<InboundMessageNotificationsListener> getInboundMessagePushListeners()
```
    Returns INBOUND Message Notifications PUSH Listeners list
  - removePushDeliveryStatusNotificationListeners
```
void removePushDeliveryStatusNotificationListeners()
```
    Remove PUSH Delivery Reports Notifications listeners and stop server
  - removePushInboundMessageListeners
```
void removePushInboundMessageListeners()
```
    Remove PUSH Delivery Reports Notifications listeners and stop server

Interface SMSMessagingClient

Method Summary

Method Detail

sendSMS

sendSMSAsync

queryDeliveryStatus

queryDeliveryStatusAsync

convertJsonToDeliveryInfoNotification

subscribeToDeliveryStatusNotifications

getDeliveryNotificationsSubscriptionsBySender

getDeliveryNotificationsSubscriptionById

getDeliveryNotificationsSubscriptions

removeDeliveryNotificationsSubscription

getInboundMessages

getInboundMessages

getInboundMessagesAsync

getInboundMessagesAsync

convertJsonToInboundSMSMessageNotificationExample

subscribeToInboundMessagesNotifications

getInboundMessagesNotificationsSubscriptions

getInboundMessagesNotificationsSubscriptions

removeInboundMessagesSubscription

getMoNumberTypes

getDeliveryReports

getDeliveryReportsAsync

getDeliveryReports

getDeliveryReportsAsync

getDeliveryReportsByRequestId

getDeliveryReportsByRequestId

addPullInboundMessageListener

addPullDeliveryReportListener

getInboundMessagePullListeners

getDeliveryReportPullListeners

removePullDeliveryReportListeners

removePullInboundMessageListeners

addPushDeliveryStatusNotificationListener

addPushInboundMessageListener

getDeliveryStatusNotificationPushListeners

getInboundMessagePushListeners

removePushDeliveryStatusNotificationListeners

removePushInboundMessageListeners