Interface MediaRequest

All Superinterfaces:
BatchRequest

public interface MediaRequest extends BatchRequest
Only available in the US. Contact your account manager if you wish to send MMS.
  • Method Details

    • getTo

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

      Field is required

      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
    • getBody

      MediaBody getBody()
      Get body

      Field is required

      Returns:
      body
    • 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
    • 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
    • getStrictValidation

      Boolean getStrictValidation()
      Whether or not you want the media included in your message to be checked against Sinch MMS channel best practices. If set to true, your message will be rejected if it doesn't conform to the listed recommendations, otherwise no validation will be performed.
      Returns:
      strictValidation
    • builder

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