Package com.sinch.sdk.domains.sms.models.v1.batches.request

Interface UpdateTextRequest

All Superinterfaces:
UpdateBatchRequest
public interface UpdateTextRequest extends UpdateBatchRequest
Update text message

  • Method Details

    • getFrom

      String getFrom()
      Sender number. Must be valid phone number, short code or alphanumeric.
      Returns:
      from

    • getToAdd

      List<String> getToAdd()
      List of phone numbers and group IDs to add to the batch.
      Returns:
      toAdd

    • getToRemove

      List<String> getToRemove()
      List of phone numbers and group IDs to remove from the batch.
      Returns:
      toRemove

    • getDeliveryReport

      DeliveryReportType getDeliveryReport()
      Get deliveryReport
      Returns:
      deliveryReport

    • getSendAt

      Instant getSendAt()
      If set, in the future the message will be delayed until send_at occurs. Formatted as ISO-8601: YYYY-MM-DDThh:mm:ss.SSSZ. Constraints: Must be before expire_at. If set in the past, messages will be sent immediately.
      Returns:
      sendAt

    • getExpireAt

      Instant getExpireAt()
      If set, the system will stop trying to deliver the message at this point. Constraints: Must be after send_at Default: 3 days after send_at
      Returns:
      expireAt

    • getCallbackUrl

      String getCallbackUrl()
      Override the default callback URL for this batch. Constraints: Must be valid URL.
      Returns:
      callbackUrl

    • getClientReference

      String getClientReference()
      The client identifier of a batch message. If set, the identifier will be added in the delivery report/callback of this batch
      Returns:
      clientReference

    • getFeedbackEnabled

      Boolean getFeedbackEnabled()
      If set to true, then feedback is expected after successful delivery.
      Returns:
      feedbackEnabled

    • getParameters

      Map<String,Map<String,String>> getParameters()
      Contains the parameters that will be used for customizing the message for each recipient. Click here to learn more about parameterization.
      Returns:
      parameters

    • getBody

      String getBody()
      The message content
      Returns:
      body

    • getFromTon

      Integer getFromTon()
      The type of number for the sender number. Use to override the automatic detection.

      minimum: 0 maximum: 6

      Returns:
      fromTon

    • getFromNpi

      Integer getFromNpi()
      Number Plan Indicator for the sender number. Use to override the automatic detection.

      minimum: 0 maximum: 18

      Returns:
      fromNpi

    • getMaxNumberOfMessageParts

      Integer getMaxNumberOfMessageParts()
      Message will be dispatched only if it is not split to more parts than Max Number of Message Parts

      minimum: 1

      Returns:
      maxNumberOfMessageParts

    • getTruncateConcat

      Boolean getTruncateConcat()
      If set to true the message will be shortened when exceeding one part.
      Returns:
      truncateConcat

    • getFlashMessage

      Boolean getFlashMessage()
      Shows message on screen without user interaction while not saving the message to the inbox.
      Returns:
      flashMessage

    • builder

      static UpdateTextRequest.Builder builder()
      Getting builder
      Returns:
      New Builder instance