com.infobip.api

Class SendSmsApi

java.lang.Object

com.infobip.api.SendSmsApi

public class SendSmsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SendSmsApi()
SendSmsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
SmsDeliveryResult	getOutboundSmsMessageDeliveryReports(String bulkId, String messageId, Integer limit) Get outbound SMS message delivery reports.
okhttp3.Call	getOutboundSmsMessageDeliveryReportsAsync(String bulkId, String messageId, Integer limit, ApiCallback<SmsDeliveryResult> _callback) Get outbound SMS message delivery reports (asynchronously).
okhttp3.Call	getOutboundSmsMessageDeliveryReportsCall(String bulkId, String messageId, Integer limit, ApiCallback _callback) Build call for getOutboundSmsMessageDeliveryReports.
ApiResponse<SmsDeliveryResult>	getOutboundSmsMessageDeliveryReportsWithHttpInfo(String bulkId, String messageId, Integer limit) Get outbound SMS message delivery reports.
SmsLogsResponse	getOutboundSmsMessageLogs(String from, String to, List<String> bulkId, List<String> messageId, String generalStatus, OffsetDateTime sentSince, OffsetDateTime sentUntil, Integer limit, String mcc, String mnc) Get outbound SMS message logs.
okhttp3.Call	getOutboundSmsMessageLogsAsync(String from, String to, List<String> bulkId, List<String> messageId, String generalStatus, OffsetDateTime sentSince, OffsetDateTime sentUntil, Integer limit, String mcc, String mnc, ApiCallback<SmsLogsResponse> _callback) Get outbound SMS message logs (asynchronously).
okhttp3.Call	getOutboundSmsMessageLogsCall(String from, String to, List<String> bulkId, List<String> messageId, String generalStatus, OffsetDateTime sentSince, OffsetDateTime sentUntil, Integer limit, String mcc, String mnc, ApiCallback _callback) Build call for getOutboundSmsMessageLogs.
ApiResponse<SmsLogsResponse>	getOutboundSmsMessageLogsWithHttpInfo(String from, String to, List<String> bulkId, List<String> messageId, String generalStatus, OffsetDateTime sentSince, OffsetDateTime sentUntil, Integer limit, String mcc, String mnc) Get outbound SMS message logs.
SmsPreviewResponse	previewSmsMessage(SmsPreviewRequest smsPreviewRequest) Preview SMS message.
okhttp3.Call	previewSmsMessageAsync(SmsPreviewRequest smsPreviewRequest, ApiCallback<SmsPreviewResponse> _callback) Preview SMS message (asynchronously).
okhttp3.Call	previewSmsMessageCall(SmsPreviewRequest smsPreviewRequest, ApiCallback _callback) Build call for previewSmsMessage.
ApiResponse<SmsPreviewResponse>	previewSmsMessageWithHttpInfo(SmsPreviewRequest smsPreviewRequest) Preview SMS message.
SmsResponse	sendBinarySmsMessage(SmsAdvancedBinaryRequest smsAdvancedBinaryRequest) Send binary SMS message.
okhttp3.Call	sendBinarySmsMessageAsync(SmsAdvancedBinaryRequest smsAdvancedBinaryRequest, ApiCallback<SmsResponse> _callback) Send binary SMS message (asynchronously).
okhttp3.Call	sendBinarySmsMessageCall(SmsAdvancedBinaryRequest smsAdvancedBinaryRequest, ApiCallback _callback) Build call for sendBinarySmsMessage.
ApiResponse<SmsResponse>	sendBinarySmsMessageWithHttpInfo(SmsAdvancedBinaryRequest smsAdvancedBinaryRequest) Send binary SMS message.
SmsResponse	sendSmsMessage(SmsAdvancedTextualRequest smsAdvancedTextualRequest) Send SMS message.
okhttp3.Call	sendSmsMessageAsync(SmsAdvancedTextualRequest smsAdvancedTextualRequest, ApiCallback<SmsResponse> _callback) Send SMS message (asynchronously).
okhttp3.Call	sendSmsMessageCall(SmsAdvancedTextualRequest smsAdvancedTextualRequest, ApiCallback _callback) Build call for sendSmsMessage.
ApiResponse<SmsResponse>	sendSmsMessageWithHttpInfo(SmsAdvancedTextualRequest smsAdvancedTextualRequest) Send SMS message.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

SendSmsApi

public SendSmsApi()

SendSmsApi

public SendSmsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getOutboundSmsMessageDeliveryReportsCall

public okhttp3.Call getOutboundSmsMessageDeliveryReportsCall(String bulkId,
                                                             String messageId,
                                                             Integer limit,
                                                             ApiCallback _callback)
                                                      throws ApiException

Build call for getOutboundSmsMessageDeliveryReports.

Parameters:

bulkId - Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. (optional)

messageId - Unique message ID for which a report is requested. (optional)

limit - Maximum number of delivery reports to be returned. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

See Also:

Learn more about SMS channel and use cases

getOutboundSmsMessageDeliveryReports

public SmsDeliveryResult getOutboundSmsMessageDeliveryReports(String bulkId,
                                                              String messageId,
                                                              Integer limit)
                                                       throws ApiException

Get outbound SMS message delivery reports. If you are for any reason unable to receive real-time delivery reports on your endpoint, you can use this API method to learn if and when the message has been delivered to the recipient. Each request will return a batch of delivery reports - only once. The following API request will return only new reports that arrived since the last API request in the last 48 hours.

Parameters:

bulkId - Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. (optional)

messageId - Unique message ID for which a report is requested. (optional)

limit - Maximum number of delivery reports to be returned. (optional)

Returns:

SmsDeliveryResult

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Learn more about SMS channel and use cases

getOutboundSmsMessageDeliveryReportsWithHttpInfo

public ApiResponse<SmsDeliveryResult> getOutboundSmsMessageDeliveryReportsWithHttpInfo(String bulkId,
                                                                                       String messageId,
                                                                                       Integer limit)
                                                                                throws ApiException

Get outbound SMS message delivery reports. If you are for any reason unable to receive real-time delivery reports on your endpoint, you can use this API method to learn if and when the message has been delivered to the recipient. Each request will return a batch of delivery reports - only once. The following API request will return only new reports that arrived since the last API request in the last 48 hours.

Parameters:

bulkId - Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. (optional)

messageId - Unique message ID for which a report is requested. (optional)

limit - Maximum number of delivery reports to be returned. (optional)

Returns:

ApiResponse<SmsDeliveryResult>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Learn more about SMS channel and use cases

getOutboundSmsMessageDeliveryReportsAsync

public okhttp3.Call getOutboundSmsMessageDeliveryReportsAsync(String bulkId,
                                                              String messageId,
                                                              Integer limit,
                                                              ApiCallback<SmsDeliveryResult> _callback)
                                                       throws ApiException

Get outbound SMS message delivery reports (asynchronously). If you are for any reason unable to receive real-time delivery reports on your endpoint, you can use this API method to learn if and when the message has been delivered to the recipient. Each request will return a batch of delivery reports - only once. The following API request will return only new reports that arrived since the last API request in the last 48 hours.

Parameters:

bulkId - Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. (optional)

messageId - Unique message ID for which a report is requested. (optional)

limit - Maximum number of delivery reports to be returned. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

See Also:

Learn more about SMS channel and use cases

getOutboundSmsMessageLogsCall

public okhttp3.Call getOutboundSmsMessageLogsCall(String from,
                                                  String to,
                                                  List<String> bulkId,
                                                  List<String> messageId,
                                                  String generalStatus,
                                                  OffsetDateTime sentSince,
                                                  OffsetDateTime sentUntil,
                                                  Integer limit,
                                                  String mcc,
                                                  String mnc,
                                                  ApiCallback _callback)
                                           throws ApiException

Build call for getOutboundSmsMessageLogs.

Parameters:

from - The sender ID which can be alphanumeric or numeric. (optional)

to - Message destination address. (optional)

bulkId - Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. (optional)

messageId - Unique message ID for which a log is requested. (optional)

generalStatus - Sent [message status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes). Possible values: `ACCEPTED`, `PENDING`, `UNDELIVERABLE`, `DELIVERED`, `REJECTED`, `EXPIRED`. (optional)

sentSince - Sets the lower limit on the date and time filter for sent messages. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. (optional)

sentUntil - Sets the upper limit on the date and time filter for sent messages. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. (optional)

limit - Maximum number of messages to include in logs. If you want to fetch more than `1000` logs, you can retrieve them in pages using `sentSince` and `sentUntil` parameters. Defaults to `50`. (optional)

mcc - Mobile Country Code. (optional)

mnc - Mobile Network Code. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

See Also:

Learn more about SMS channel and use cases

getOutboundSmsMessageLogs

public SmsLogsResponse getOutboundSmsMessageLogs(String from,
                                                 String to,
                                                 List<String> bulkId,
                                                 List<String> messageId,
                                                 String generalStatus,
                                                 OffsetDateTime sentSince,
                                                 OffsetDateTime sentUntil,
                                                 Integer limit,
                                                 String mcc,
                                                 String mnc)
                                          throws ApiException

Get outbound SMS message logs. Use this method for displaying logs for example in the user interface. The only available logs are for the last 48 hours. See [message delivery reports](#channels/sms/get-outbound-sms-message-delivery-reports) if your use case is to verify message delivery.

Parameters:

from - The sender ID which can be alphanumeric or numeric. (optional)

to - Message destination address. (optional)

bulkId - Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. (optional)

messageId - Unique message ID for which a log is requested. (optional)

generalStatus - Sent [message status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes). Possible values: `ACCEPTED`, `PENDING`, `UNDELIVERABLE`, `DELIVERED`, `REJECTED`, `EXPIRED`. (optional)

sentSince - Sets the lower limit on the date and time filter for sent messages. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. (optional)

sentUntil - Sets the upper limit on the date and time filter for sent messages. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. (optional)

limit - Maximum number of messages to include in logs. If you want to fetch more than `1000` logs, you can retrieve them in pages using `sentSince` and `sentUntil` parameters. Defaults to `50`. (optional)

mcc - Mobile Country Code. (optional)

mnc - Mobile Network Code. (optional)

Returns:

SmsLogsResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Learn more about SMS channel and use cases

getOutboundSmsMessageLogsWithHttpInfo

public ApiResponse<SmsLogsResponse> getOutboundSmsMessageLogsWithHttpInfo(String from,
                                                                          String to,
                                                                          List<String> bulkId,
                                                                          List<String> messageId,
                                                                          String generalStatus,
                                                                          OffsetDateTime sentSince,
                                                                          OffsetDateTime sentUntil,
                                                                          Integer limit,
                                                                          String mcc,
                                                                          String mnc)
                                                                   throws ApiException

Get outbound SMS message logs. Use this method for displaying logs for example in the user interface. The only available logs are for the last 48 hours. See [message delivery reports](#channels/sms/get-outbound-sms-message-delivery-reports) if your use case is to verify message delivery.

Parameters:

from - The sender ID which can be alphanumeric or numeric. (optional)

to - Message destination address. (optional)

bulkId - Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. (optional)

messageId - Unique message ID for which a log is requested. (optional)

generalStatus - Sent [message status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes). Possible values: `ACCEPTED`, `PENDING`, `UNDELIVERABLE`, `DELIVERED`, `REJECTED`, `EXPIRED`. (optional)

sentSince - Sets the lower limit on the date and time filter for sent messages. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. (optional)

sentUntil - Sets the upper limit on the date and time filter for sent messages. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. (optional)

limit - Maximum number of messages to include in logs. If you want to fetch more than `1000` logs, you can retrieve them in pages using `sentSince` and `sentUntil` parameters. Defaults to `50`. (optional)

mcc - Mobile Country Code. (optional)

mnc - Mobile Network Code. (optional)

Returns:

ApiResponse<SmsLogsResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Learn more about SMS channel and use cases

getOutboundSmsMessageLogsAsync

public okhttp3.Call getOutboundSmsMessageLogsAsync(String from,
                                                   String to,
                                                   List<String> bulkId,
                                                   List<String> messageId,
                                                   String generalStatus,
                                                   OffsetDateTime sentSince,
                                                   OffsetDateTime sentUntil,
                                                   Integer limit,
                                                   String mcc,
                                                   String mnc,
                                                   ApiCallback<SmsLogsResponse> _callback)
                                            throws ApiException

Get outbound SMS message logs (asynchronously). Use this method for displaying logs for example in the user interface. The only available logs are for the last 48 hours. See [message delivery reports](#channels/sms/get-outbound-sms-message-delivery-reports) if your use case is to verify message delivery.

Parameters:

from - The sender ID which can be alphanumeric or numeric. (optional)

to - Message destination address. (optional)

bulkId - Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. (optional)

messageId - Unique message ID for which a log is requested. (optional)

generalStatus - Sent [message status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes). Possible values: `ACCEPTED`, `PENDING`, `UNDELIVERABLE`, `DELIVERED`, `REJECTED`, `EXPIRED`. (optional)

sentSince - Sets the lower limit on the date and time filter for sent messages. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. (optional)

sentUntil - Sets the upper limit on the date and time filter for sent messages. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. (optional)

limit - Maximum number of messages to include in logs. If you want to fetch more than `1000` logs, you can retrieve them in pages using `sentSince` and `sentUntil` parameters. Defaults to `50`. (optional)

mcc - Mobile Country Code. (optional)

mnc - Mobile Network Code. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

See Also:

Learn more about SMS channel and use cases

previewSmsMessageCall

public okhttp3.Call previewSmsMessageCall(SmsPreviewRequest smsPreviewRequest,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for previewSmsMessage.

Parameters:

smsPreviewRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

See Also:

Learn more about SMS channel and use cases

previewSmsMessage

public SmsPreviewResponse previewSmsMessage(SmsPreviewRequest smsPreviewRequest)
                                     throws ApiException

Preview SMS message. Avoid unpleasant surprises and check how different message configurations will affect your message text, number of characters and message parts.

Parameters:

smsPreviewRequest - (optional)

Returns:

SmsPreviewResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Learn more about SMS channel and use cases

previewSmsMessageWithHttpInfo

public ApiResponse<SmsPreviewResponse> previewSmsMessageWithHttpInfo(SmsPreviewRequest smsPreviewRequest)
                                                              throws ApiException

Preview SMS message. Avoid unpleasant surprises and check how different message configurations will affect your message text, number of characters and message parts.

Parameters:

smsPreviewRequest - (optional)

Returns:

ApiResponse<SmsPreviewResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Learn more about SMS channel and use cases

previewSmsMessageAsync

public okhttp3.Call previewSmsMessageAsync(SmsPreviewRequest smsPreviewRequest,
                                           ApiCallback<SmsPreviewResponse> _callback)
                                    throws ApiException

Preview SMS message (asynchronously). Avoid unpleasant surprises and check how different message configurations will affect your message text, number of characters and message parts.

Parameters:

smsPreviewRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

See Also:

Learn more about SMS channel and use cases

sendBinarySmsMessageCall

public okhttp3.Call sendBinarySmsMessageCall(SmsAdvancedBinaryRequest smsAdvancedBinaryRequest,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for sendBinarySmsMessage.

Parameters:

smsAdvancedBinaryRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

See Also:

Learn more about SMS channel and use cases

sendBinarySmsMessage

public SmsResponse sendBinarySmsMessage(SmsAdvancedBinaryRequest smsAdvancedBinaryRequest)
                                 throws ApiException

Send binary SMS message. Send single or multiple binary messages to one or more destination address.

Parameters:

smsAdvancedBinaryRequest - (optional)

Returns:

SmsResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Learn more about SMS channel and use cases

sendBinarySmsMessageWithHttpInfo

public ApiResponse<SmsResponse> sendBinarySmsMessageWithHttpInfo(SmsAdvancedBinaryRequest smsAdvancedBinaryRequest)
                                                          throws ApiException

Send binary SMS message. Send single or multiple binary messages to one or more destination address.

Parameters:

smsAdvancedBinaryRequest - (optional)

Returns:

ApiResponse<SmsResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Learn more about SMS channel and use cases

sendBinarySmsMessageAsync

public okhttp3.Call sendBinarySmsMessageAsync(SmsAdvancedBinaryRequest smsAdvancedBinaryRequest,
                                              ApiCallback<SmsResponse> _callback)
                                       throws ApiException

Send binary SMS message (asynchronously). Send single or multiple binary messages to one or more destination address.

Parameters:

smsAdvancedBinaryRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

See Also:

Learn more about SMS channel and use cases

sendSmsMessageCall

public okhttp3.Call sendSmsMessageCall(SmsAdvancedTextualRequest smsAdvancedTextualRequest,
                                       ApiCallback _callback)
                                throws ApiException

Build call for sendSmsMessage.

Parameters:

smsAdvancedTextualRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

See Also:

Learn more about SMS channel and use cases

sendSmsMessage

public SmsResponse sendSmsMessage(SmsAdvancedTextualRequest smsAdvancedTextualRequest)
                           throws ApiException

Send SMS message. 99% of all use cases can be achieved by using this API method. Everything from sending a simple single message to a single destination, up to batch sending of personalized messages to the thousands of recipients with a single API request. Language, transliteration, scheduling and every advanced feature you can think of is supported.

Parameters:

smsAdvancedTextualRequest - (optional)

Returns:

SmsResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Learn more about SMS channel and use cases

sendSmsMessageWithHttpInfo

public ApiResponse<SmsResponse> sendSmsMessageWithHttpInfo(SmsAdvancedTextualRequest smsAdvancedTextualRequest)
                                                    throws ApiException

Send SMS message. 99% of all use cases can be achieved by using this API method. Everything from sending a simple single message to a single destination, up to batch sending of personalized messages to the thousands of recipients with a single API request. Language, transliteration, scheduling and every advanced feature you can think of is supported.

Parameters:

smsAdvancedTextualRequest - (optional)

Returns:

ApiResponse<SmsResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

See Also:

Learn more about SMS channel and use cases

sendSmsMessageAsync

public okhttp3.Call sendSmsMessageAsync(SmsAdvancedTextualRequest smsAdvancedTextualRequest,
                                        ApiCallback<SmsResponse> _callback)
                                 throws ApiException

Send SMS message (asynchronously). 99% of all use cases can be achieved by using this API method. Everything from sending a simple single message to a single destination, up to batch sending of personalized messages to the thousands of recipients with a single API request. Language, transliteration, scheduling and every advanced feature you can think of is supported.

Parameters:

smsAdvancedTextualRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

See Also:

Learn more about SMS channel and use cases