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

Interface BinaryResponse

All Superinterfaces:
BatchResponse
public interface BinaryResponse extends BatchResponse
BinaryResponse

  • 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()
      A list of phone numbers and group IDs that have received the batch. More info.
      Returns:
      to

    • getFrom

      String getFrom()
      The sender number provided. Required if the Automatic Default Originator is not configured.
      Returns:
      from

    • getCanceled

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

    • getBody

      String getBody()
      The message content provided. Base64 encoded.
      Returns:
      body

    • getUdh

      String getUdh()
      The UDH header of a binary message HEX encoded. Max 140 bytes including the body.
      Returns:
      udh

    • getCreatedAt

      Instant getCreatedAt()
      Timestamp for when batch was created. Formatted as ISO-8601. For example: 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. For example: YYYY-MM-DDThh:mm:ss.SSSZ.
      Returns:
      modifiedAt
      Read Only
      This field is returned by the server and cannot be modified

    • getDeliveryReport

      DeliveryReportType getDeliveryReport()
      The delivery report callback option selected. Will be either none, summary , full, per_recipient, or per_recipient_final.
      Returns:
      deliveryReport

    • getSendAt

      Instant getSendAt()
      If set, the date and time the message should be delivered. Formatted as ISO-8601. For example: YYYY-MM-DDThh:mm:ss.SSSZ.
      Returns:
      sendAt

    • getExpireAt

      Instant getExpireAt()
      If set, the date and time the message will expire. Formatted as ISO-8601. For example: YYYY-MM-DDThh:mm:ss.SSSZ.
      Returns:
      expireAt

    • getEventDestinationTarget

      String getEventDestinationTarget()
      The callback URL provided in the request.
      Returns:
      eventDestinationTarget

    • getClientReference

      String getClientReference()
      The string input to identify this 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

    • getFromTon

      Integer getFromTon()
      The type of number for the sender number.

      minimum: 0 maximum: 6

      Returns:
      fromTon

    • getFromNpi

      Integer getFromNpi()
      Number Plan Indicator for the sender number.

      minimum: 0 maximum: 18

      Returns:
      fromNpi

    • builder

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