SmsTextualMessage (infobip-api-java-client 3.2.0 API)

java.lang.Object
- com.infobip.model.SmsTextualMessage

public class SmsTextualMessage
extends Object

SmsTextualMessage

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_CALLBACK_DATA`
`static String`	`SERIALIZED_NAME_DELIVERY_TIME_WINDOW`
`static String`	`SERIALIZED_NAME_DESTINATIONS`
`static String`	`SERIALIZED_NAME_FLASH`
`static String`	`SERIALIZED_NAME_FROM`
`static String`	`SERIALIZED_NAME_INTERMEDIATE_REPORT`
`static String`	`SERIALIZED_NAME_LANGUAGE`
`static String`	`SERIALIZED_NAME_NOTIFY_CONTENT_TYPE`
`static String`	`SERIALIZED_NAME_NOTIFY_URL`
`static String`	`SERIALIZED_NAME_REGIONAL`
`static String`	`SERIALIZED_NAME_SEND_AT`
`static String`	`SERIALIZED_NAME_TEXT`
`static String`	`SERIALIZED_NAME_TRANSLITERATION`
`static String`	`SERIALIZED_NAME_VALIDITY_PERIOD`

Constructor Summary

Constructors
Constructor and Description

SmsTextualMessage()

Constructors
Constructor and Description
`SmsTextualMessage()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SmsTextualMessage`	`addDestinationsItem(SmsDestination destinationsItem)`
`SmsTextualMessage`	`callbackData(String callbackData)`
`SmsTextualMessage`	`deliveryTimeWindow(SmsDeliveryTimeWindow deliveryTimeWindow)`
`SmsTextualMessage`	`destinations(List<SmsDestination> destinations)`
`boolean`	`equals(Object o)`
`SmsTextualMessage`	`flash(Boolean flash)`
`SmsTextualMessage`	`from(String from)`
`String`	`getCallbackData()` Additional client data to be sent over the `notifyUrl`.
`SmsDeliveryTimeWindow`	`getDeliveryTimeWindow()` Sets specific scheduling options to send a message within daily or hourly intervals.
`List<SmsDestination>`	`getDestinations()` An array of destination objects for where messages are being sent.
`Boolean`	`getFlash()` Allows for sending a [flash SMS](https://www.infobip.com/docs/sms/message-types#flash-sms) to automatically appear on recipient devices without interaction.
`String`	`getFrom()` The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
`Boolean`	`getIntermediateReport()` The [real-time intermediate delivery report](#channels/sms/receive-outbound-sms-message-report) containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server.
`SmsLanguage`	`getLanguage()` Sets the language parameters for the message being sent.
`String`	`getNotifyContentType()` Preferred delivery report content type, `application/json` or `application/xml`.
`String`	`getNotifyUrl()` The URL on your call back server on to which a delivery report will be sent.
`SmsRegionalOptions`	`getRegional()` Region-specific parameters, often imposed by local laws.
`OffsetDateTime`	`getSendAt()` Date and time when the message is to be sent.
`String`	`getText()` Content of the message being sent.
`String`	`getTransliteration()` The transliteration of your sent message from one script to another.
`Long`	`getValidityPeriod()` The message validity period in minutes.
`int`	`hashCode()`
`SmsTextualMessage`	`intermediateReport(Boolean intermediateReport)`
`SmsTextualMessage`	`language(SmsLanguage language)`
`SmsTextualMessage`	`notifyContentType(String notifyContentType)`
`SmsTextualMessage`	`notifyUrl(String notifyUrl)`
`SmsTextualMessage`	`regional(SmsRegionalOptions regional)`
`SmsTextualMessage`	`sendAt(OffsetDateTime sendAt)`
`void`	`setCallbackData(String callbackData)`
`void`	`setDeliveryTimeWindow(SmsDeliveryTimeWindow deliveryTimeWindow)`
`void`	`setDestinations(List<SmsDestination> destinations)`
`void`	`setFlash(Boolean flash)`
`void`	`setFrom(String from)`
`void`	`setIntermediateReport(Boolean intermediateReport)`
`void`	`setLanguage(SmsLanguage language)`
`void`	`setNotifyContentType(String notifyContentType)`
`void`	`setNotifyUrl(String notifyUrl)`
`void`	`setRegional(SmsRegionalOptions regional)`
`void`	`setSendAt(OffsetDateTime sendAt)`
`void`	`setText(String text)`
`void`	`setTransliteration(String transliteration)`
`void`	`setValidityPeriod(Long validityPeriod)`
`SmsTextualMessage`	`text(String text)`
`String`	`toString()`
`SmsTextualMessage`	`transliteration(String transliteration)`
`SmsTextualMessage`	`validityPeriod(Long validityPeriod)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_CALLBACK_DATA
```
public static final String SERIALIZED_NAME_CALLBACK_DATA
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DELIVERY_TIME_WINDOW
```
public static final String SERIALIZED_NAME_DELIVERY_TIME_WINDOW
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DESTINATIONS
```
public static final String SERIALIZED_NAME_DESTINATIONS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FLASH
```
public static final String SERIALIZED_NAME_FLASH
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FROM
```
public static final String SERIALIZED_NAME_FROM
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_INTERMEDIATE_REPORT
```
public static final String SERIALIZED_NAME_INTERMEDIATE_REPORT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LANGUAGE
```
public static final String SERIALIZED_NAME_LANGUAGE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_NOTIFY_CONTENT_TYPE
```
public static final String SERIALIZED_NAME_NOTIFY_CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_NOTIFY_URL
```
public static final String SERIALIZED_NAME_NOTIFY_URL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_REGIONAL
```
public static final String SERIALIZED_NAME_REGIONAL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SEND_AT
```
public static final String SERIALIZED_NAME_SEND_AT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TEXT
```
public static final String SERIALIZED_NAME_TEXT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TRANSLITERATION
```
public static final String SERIALIZED_NAME_TRANSLITERATION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_VALIDITY_PERIOD
```
public static final String SERIALIZED_NAME_VALIDITY_PERIOD
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SmsTextualMessage
```
public SmsTextualMessage()
```
- Method Detail
  - callbackData
```
public SmsTextualMessage callbackData(String callbackData)
```
  - getCallbackData
```
public String getCallbackData()
```
    Additional client data to be sent over the `notifyUrl`. The maximum value is 4000 characters.
    
    Returns:
    
    callbackData
  - setCallbackData
```
public void setCallbackData(String callbackData)
```
  - deliveryTimeWindow
```
public SmsTextualMessage deliveryTimeWindow(SmsDeliveryTimeWindow deliveryTimeWindow)
```
  - getDeliveryTimeWindow
```
public SmsDeliveryTimeWindow getDeliveryTimeWindow()
```
    Sets specific scheduling options to send a message within daily or hourly intervals.
    
    Returns:
    
    deliveryTimeWindow
  - setDeliveryTimeWindow
```
public void setDeliveryTimeWindow(SmsDeliveryTimeWindow deliveryTimeWindow)
```
  - destinations
```
public SmsTextualMessage destinations(List<SmsDestination> destinations)
```
  - addDestinationsItem
```
public SmsTextualMessage addDestinationsItem(SmsDestination destinationsItem)
```
  - getDestinations
```
public List<SmsDestination> getDestinations()
```
    An array of destination objects for where messages are being sent. A valid destination is required.
    
    Returns:
    
    destinations
  - setDestinations
```
public void setDestinations(List<SmsDestination> destinations)
```
  - flash
```
public SmsTextualMessage flash(Boolean flash)
```
  - getFlash
```
public Boolean getFlash()
```
    Allows for sending a [flash SMS](https://www.infobip.com/docs/sms/message-types#flash-sms) to automatically appear on recipient devices without interaction. Set to `true` to enable flash SMS, or leave the default value, `false` to send a standard SMS.
    
    Returns:
    
    flash
  - setFlash
```
public void setFlash(Boolean flash)
```
  - from
```
public SmsTextualMessage from(String from)
```
  - getFrom
```
public String getFrom()
```
    The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
    
    Returns:
    
    from
  - setFrom
```
public void setFrom(String from)
```
  - intermediateReport
```
public SmsTextualMessage intermediateReport(Boolean intermediateReport)
```
  - getIntermediateReport
```
public Boolean getIntermediateReport()
```
    The [real-time intermediate delivery report](#channels/sms/receive-outbound-sms-message-report) containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.
    
    Returns:
    
    intermediateReport
  - setIntermediateReport
```
public void setIntermediateReport(Boolean intermediateReport)
```
  - language
```
public SmsTextualMessage language(SmsLanguage language)
```
  - getLanguage
```
public SmsLanguage getLanguage()
```
    Sets the language parameters for the message being sent.
    
    Returns:
    
    language
  - setLanguage
```
public void setLanguage(SmsLanguage language)
```
  - notifyContentType
```
public SmsTextualMessage notifyContentType(String notifyContentType)
```
  - getNotifyContentType
```
public String getNotifyContentType()
```
    Preferred delivery report content type, `application/json` or `application/xml`.
    
    Returns:
    
    notifyContentType
  - setNotifyContentType
```
public void setNotifyContentType(String notifyContentType)
```
  - notifyUrl
```
public SmsTextualMessage notifyUrl(String notifyUrl)
```
  - getNotifyUrl
```
public String getNotifyUrl()
```
    The URL on your call back server on to which a delivery report will be sent. The [retry cycle](https://www.infobip.com/docs/sms/api#notify-url) for when your URL becomes unavailable uses the following formula: `1min + (1min * <retrynumber> * <retrynumber>)</retrynumber></retrynumber>`.
    
    Returns:
    
    notifyUrl
  - setNotifyUrl
```
public void setNotifyUrl(String notifyUrl)
```
  - regional
```
public SmsTextualMessage regional(SmsRegionalOptions regional)
```
  - getRegional
```
public SmsRegionalOptions getRegional()
```
    Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.
    
    Returns:
    
    regional
  - setRegional
```
public void setRegional(SmsRegionalOptions regional)
```
  - sendAt
```
public SmsTextualMessage sendAt(OffsetDateTime sendAt)
```
  - getSendAt
```
public OffsetDateTime getSendAt()
```
    Date and time when the message is to be sent. Used for [scheduled SMS](#channels/sms/get-scheduled-sms-messages). Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Must be sooner than 180 days from now.
    
    Returns:
    
    sendAt
  - setSendAt
```
public void setSendAt(OffsetDateTime sendAt)
```
  - text
```
public SmsTextualMessage text(String text)
```
  - getText
```
public String getText()
```
    Content of the message being sent.
    
    Returns:
    
    text
  - setText
```
public void setText(String text)
```
  - transliteration
```
public SmsTextualMessage transliteration(String transliteration)
```
  - getTransliteration
```
public String getTransliteration()
```
    The transliteration of your sent message from one script to another. Transliteration is used to replace characters which are not recognized as part of your defaulted alphabet. Possible values: `TURKISH`, `GREEK`, `CYRILLIC`, `SERBIAN_CYRILLIC`, `CENTRAL_EUROPEAN`, `BALTIC` and `NON_UNICODE`.
    
    Returns:
    
    transliteration
  - setTransliteration
```
public void setTransliteration(String transliteration)
```
  - validityPeriod
```
public SmsTextualMessage validityPeriod(Long validityPeriod)
```
  - getValidityPeriod
```
public Long getValidityPeriod()
```
    The message validity period in minutes. When the period expires, it will not be allowed for the message to be sent. Validity period longer than 48h is not supported. Any bigger value will automatically default back to `2880`.
    
    Returns:
    
    validityPeriod
  - setValidityPeriod
```
public void setValidityPeriod(Long validityPeriod)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SmsTextualMessage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_CALLBACK_DATA

SERIALIZED_NAME_DELIVERY_TIME_WINDOW

SERIALIZED_NAME_DESTINATIONS

SERIALIZED_NAME_FLASH

SERIALIZED_NAME_FROM

SERIALIZED_NAME_INTERMEDIATE_REPORT

SERIALIZED_NAME_LANGUAGE

SERIALIZED_NAME_NOTIFY_CONTENT_TYPE

SERIALIZED_NAME_NOTIFY_URL

SERIALIZED_NAME_REGIONAL

SERIALIZED_NAME_SEND_AT

SERIALIZED_NAME_TEXT

SERIALIZED_NAME_TRANSLITERATION

SERIALIZED_NAME_VALIDITY_PERIOD

Constructor Detail

SmsTextualMessage

Method Detail

callbackData

getCallbackData

setCallbackData

deliveryTimeWindow

getDeliveryTimeWindow

setDeliveryTimeWindow

destinations

addDestinationsItem

getDestinations

setDestinations

flash

getFlash

setFlash

from

getFrom

setFrom

intermediateReport

getIntermediateReport

setIntermediateReport

language

getLanguage

setLanguage

notifyContentType

getNotifyContentType

setNotifyContentType

notifyUrl

getNotifyUrl

setNotifyUrl

regional

getRegional

setRegional

sendAt

getSendAt

setSendAt

text

getText

setText

transliteration

getTransliteration

setTransliteration

validityPeriod

getValidityPeriod

setValidityPeriod

equals

hashCode

toString