Package software.xdev.brevo.model

Class CreateSmsCampaign

java.lang.Object
software.xdev.brevo.model.CreateSmsCampaign
public class CreateSmsCampaign extends Object
CreateSmsCampaign

  • Field Details

  • Constructor Details

    • CreateSmsCampaign

      public CreateSmsCampaign()

  • Method Details

    • name

      public CreateSmsCampaign name(@Nonnull String name)

    • getName

      @Nonnull public String getName()
      Name of the campaign
      Returns:
      name

    • setName

      public void setName(@Nonnull String name)

    • sender

      public CreateSmsCampaign sender(@Nonnull String sender)

    • getSender

      @Nonnull public String getSender()
      Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters**
      Returns:
      sender

    • setSender

      public void setSender(@Nonnull String sender)

    • content

      public CreateSmsCampaign content(@Nonnull String content)

    • getContent

      @Nonnull public String getContent()
      Content of the message. The **maximum characters used per SMS is 160**, if used more than that, it will be counted as more than one SMS
      Returns:
      content

    • setContent

      public void setContent(@Nonnull String content)

    • recipients

      public CreateSmsCampaign recipients(@Nullable CreateSmsCampaignRecipients recipients)

    • getRecipients

      @Nullable public CreateSmsCampaignRecipients getRecipients()
      Get recipients
      Returns:
      recipients

    • setRecipients

      public void setRecipients(@Nullable CreateSmsCampaignRecipients recipients)

    • scheduledAt

      public CreateSmsCampaign scheduledAt(@Nullable String scheduledAt)

    • getScheduledAt

      @Nullable public String getScheduledAt()
      UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**
      Returns:
      scheduledAt

    • setScheduledAt

      public void setScheduledAt(@Nullable String scheduledAt)

    • unicodeEnabled

      public CreateSmsCampaign unicodeEnabled(@Nullable Boolean unicodeEnabled)

    • getUnicodeEnabled

      @Nullable public Boolean getUnicodeEnabled()
      Format of the message. It indicates whether the content should be treated as unicode or not.
      Returns:
      unicodeEnabled

    • setUnicodeEnabled

      public void setUnicodeEnabled(@Nullable Boolean unicodeEnabled)

    • organisationPrefix

      public CreateSmsCampaign organisationPrefix(@Nullable String organisationPrefix)

    • getOrganisationPrefix

      @Nullable public String getOrganisationPrefix()
      A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. **Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.**
      Returns:
      organisationPrefix

    • setOrganisationPrefix

      public void setOrganisationPrefix(@Nullable String organisationPrefix)

    • unsubscribeInstruction

      public CreateSmsCampaign unsubscribeInstruction(@Nullable String unsubscribeInstruction)

    • getUnsubscribeInstruction

      @Nullable public String getUnsubscribeInstruction()
      Instructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include **STOP** keyword. This will be added as instructions after the end of message content. **Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.**
      Returns:
      unsubscribeInstruction

    • setUnsubscribeInstruction

      public void setUnsubscribeInstruction(@Nullable String unsubscribeInstruction)

    • 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

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string