Package com.sinch.sdk.domains.conversation.models.v1.messages.request

Interface MessagesListRequest

public interface MessagesListRequest
Parameters request to list messages
Since:
1.3
See Also:

  • Method Details

    • getConversationId

      Optional<String> getConversationId()
      Resource name (ID) of the conversation.
      Returns:
      conversation id

    • getContactId

      Optional<String> getContactId()
      Resource name (ID) of the contact.

      Note that either app_id or contact_id is required in order for the operation to function correctly.

      Returns:
      contact id

    • getAppId

      Optional<String> getAppId()
      Id of the application.

      Note that either app_id or contact_id is required in order for the operation to function correctly.

      Returns:
      application id

    • getChannelIdentity

      Optional<String> getChannelIdentity()
      Channel identity of the contact.
      Returns:
      Channel identity

    • getStartTime

      Optional<Instant> getStartTime()
      Filter messages with accept_time after this timestamp.

      Must be before end_time if that is specified.

      Returns:
      Start time

    • getEndTime

      Optional<Instant> getEndTime()
      Filter messages with accept_time before this timestamp.
      Returns:
      End time

    • getPageSize

      Optional<Integer> getPageSize()
      Maximum number of messages to fetch.

      Defaults to 10 and the maximum is 1000.

      Returns:
      Page size
      Default value:
      10

    • getPageToken

      Optional<String> getPageToken()
      Next page token previously returned if any.

      When specifying this token, make sure to use the same values for the other parameters from the request that originated the token, otherwise the paged results may be inconsistent.

      Returns:
      Page token

    • getView

      Optional<ConversationMessagesView> getView()
      Returns:
      view

    • getMessagesSource

      Optional<MessagesService.MessageSource> getMessagesSource()
      Specifies the message source for which the request will be processed. Used for operations on messages in Dispatch Mode. For more information, see Processing Modes
      Returns:
      Messages sources
      Default value:
      CONVERSATION_SOURCE

    • getOnlyRecipientOriginated

      Optional<Boolean> getOnlyRecipientOriginated()
      If true, fetch only recipient originated messages. Available only when messages_source is DISPATCH_SOURCE.
      Returns:
      only recipient originated value

    • getChannel

      Optional<ConversationChannel> getChannel()
      Only fetch messages from the channel
      Returns:
      Channel to filtered on

    • builder

      static MessagesListRequest.Builder builder()

    • builder

      static MessagesListRequest.Builder builder(MessagesListRequest parameters)