Interface MediaResponse
- All Superinterfaces:
BatchResponse
MediaResponse
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceDedicated Builderstatic classMedia message -
Method Summary
Modifier and TypeMethodDescriptionstatic MediaResponse.Builderbuilder()Getting buildergetBody()Get bodyIndicates if the batch has been canceled or not.The client identifier of a batch message.Timestamp for when batch was created.Get deliveryReportOverride the default callback URL for this batch.If set the system will stop trying to deliver the message at this point.If set to true then feedback is expected after successful delivery.getFrom()Sender number.getId()Unique identifier for batchTimestamp for when batch was last updated.Contains the parameters that will be used for customizing the message for each recipient.If set in the future the message will be delayed until send_at occurs.Whether or not you want the media included in your message to be checked against Sinch MMS channel best practices.getTo()List of Phone numbers and group IDs that will receive the batch.
-
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 of Phone numbers and group IDs that will receive the batch. More info- Returns:
- to
-
getFrom
String getFrom()Sender number. 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
-
getBody
MediaBody getBody()Get body- Returns:
- body
-
getParameters
Contains the parameters that will be used for customizing the message for each recipient. Click here to learn more about parameterization.- Returns:
- parameters
-
getCreatedAt
Instant getCreatedAt()Timestamp for when batch was created. YYYY-MM-DDThh:mm:ss.SSSZ format- 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. YYYY-MM-DDThh:mm:ss.SSSZ format- 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 beforeexpire_at. If set in the past messages will be sent immediately. YYYY-MM-DDThh:mm:ss.SSSZ format- Returns:
- sendAt
-
getExpireAt
Instant getExpireAt()If set the system will stop trying to deliver the message at this point. Must be aftersend_at. Default and max is 3 days after send_at. YYYY-MM-DDThh:mm:ss.SSSZ format- 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
Getting builder- Returns:
- New Builder instance
-