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

Interface TextResponse

All Superinterfaces:
BatchResponse
public interface TextResponse extends BatchResponse
TextResponse

  • Method Details

    • getId

      String getId()
      Unique identifier for batch
      Returns:
      id
      Read Only
      This field is returned by the server and cannot be modified

    • getTo

      List<String> getTo()
      List of Phone numbers and group IDs that will receive the batch. More info
      Returns:
      to

    • getFrom

      String getFrom()
      Sender number. Must be valid phone number, short code or alphanumeric. Required if Automatic Default Originator not configured.
      Returns:
      from

    • getCanceled

      Boolean getCanceled()
      Indicates if the batch has been canceled or not.
      Returns:
      canceled
      Read Only
      This field is returned by the server and cannot be modified

    • 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

    • getCreatedAt

      Instant getCreatedAt()
      Timestamp for when batch was created. Formatted as ISO-8601:YYYY-MM-DDThh:mm:ss.SSSZ .
      Returns:
      createdAt
      Read Only
      This field is returned by the server and cannot be modified

    • getModifiedAt

      Instant getModifiedAt()
      Timestamp for when batch was last updated. Formatted as ISO-8601:YYYY-MM-DDThh:mm:ss.SSSZ .
      Returns:
      modifiedAt
      Read Only
      This field is returned by the server and cannot be modified

    • getDeliveryReport

      DeliveryReportType getDeliveryReport()
      Get deliveryReport
      Returns:
      deliveryReport

    • getSendAt

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

    • getExpireAt

      Instant getExpireAt()
      If set, the system will stop trying to deliver the message at this point. Must be after send_at. Default and max is 3 days after send_at. Formatted as ISO-8601: YYYY-MM-DDThh:mm:ss.SSSZ .
      Returns:
      expireAt

    • getEventDestinationTarget

      String getEventDestinationTarget()
      Override the default callback URL for this batch. Must be valid URL.
      Returns:
      eventDestinationTarget

    • 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

    • getFlashMessage

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

    • getTruncateConcat

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

    • 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

    • 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

    • builder

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