Package software.xdev.brevo.model
Class ConversationsMessage
java.lang.Object
software.xdev.brevo.model.ConversationsMessage
a Conversations message
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum`\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription_file(ConversationsMessageFile _file) addAttachmentsItem(ConversationsMessageAttachmentsInner attachmentsItem) addBccItem(ConversationsMessageToInner bccItem) addCcItem(ConversationsMessageToInner ccItem) addToItem(ConversationsMessageToInner toItem) agentUserpic(String agentUserpic) attachments(List<ConversationsMessageAttachmentsInner> attachments) booleanforwardedToSourceStatus(ConversationsMessageForwardedToSourceStatus forwardedToSourceStatus) from(ConversationsMessageFrom from) ID of the agent on whose behalf the message was sent (only in messages sent by an agent).Agent’s name as displayed to the visitor.Only set if the agent has uploaded a profile picture.An array of file attachments.getBcc()An array containing details of the blind carbon copy (BCC) recipients (applicable only to messages in email threads).getCc()An array containing details of the carbon copy (CC) recipients (applicable only to messages in email threads).Timestamp in milliseconds.getFile()Get _fileGet forwardedToSourceStatusgetFrom()Get fromgetHtml()The HTML content of the message.getId()Message ID.Integration details.getIsBot()`true` for automated messages generated by an AI bot.`true` for missed and offline messages.`true` for unread agent’s messages in finished chats.`true` for pushed messages`true` for automatic messages from “Targeted chats & triggers” and API (https://developers.brevo.com/docs/javascript-api-reference#sendautomessage)Unescaped HTML content of the message (may include unsafe HTML).In two-way integrations, messages sent via REST API can be marked with receivedFrom property and then filtered out when received in a webhook to avoid infinite loop.Get replyToThe ID of the message assigned by the integration source.The subject line of the email message (only for messages sent to email threads).getText()Message text or name of the attached filegetTo()An array containing details of the recipients (applicable only to messages in email threads).getType()`\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages.visitor’s IDinthashCode()integrations(Object integrations) isMissedByVisitor(Boolean isMissedByVisitor) rawUnsafeHtml(String rawUnsafeHtml) receivedFrom(String receivedFrom) replyTo(ConversationsMessageReplyTo replyTo) voidsetAgentId(String agentId) voidsetAgentName(String agentName) voidsetAgentUserpic(String agentUserpic) voidsetAttachments(List<ConversationsMessageAttachmentsInner> attachments) voidvoidvoidsetCreatedAt(Long createdAt) voidsetFile(ConversationsMessageFile _file) voidsetForwardedToSourceStatus(ConversationsMessageForwardedToSourceStatus forwardedToSourceStatus) voidvoidvoidvoidsetIntegrations(Object integrations) voidvoidsetIsMissed(Boolean isMissed) voidsetIsMissedByVisitor(Boolean isMissedByVisitor) voidsetIsPushed(Boolean isPushed) voidsetIsTrigger(Boolean isTrigger) voidsetRawUnsafeHtml(String rawUnsafeHtml) voidsetReceivedFrom(String receivedFrom) voidsetReplyTo(ConversationsMessageReplyTo replyTo) voidsetSourceMessageId(String sourceMessageId) voidsetSubject(String subject) voidvoidvoidvoidsetVisitorId(String visitorId) sourceMessageId(String sourceMessageId) toString()Convert the instance into URL query string.toUrlQueryString(String prefix) Convert the instance into URL query string.
-
Field Details
-
JSON_PROPERTY_ID
- See Also:
-
JSON_PROPERTY_TYPE
- See Also:
-
JSON_PROPERTY_TEXT
- See Also:
-
JSON_PROPERTY_SUBJECT
- See Also:
-
JSON_PROPERTY_HTML
- See Also:
-
JSON_PROPERTY_RAW_UNSAFE_HTML
- See Also:
-
JSON_PROPERTY_VISITOR_ID
- See Also:
-
JSON_PROPERTY_AGENT_ID
- See Also:
-
JSON_PROPERTY_AGENT_NAME
- See Also:
-
JSON_PROPERTY_CREATED_AT
- See Also:
-
JSON_PROPERTY_IS_PUSHED
- See Also:
-
JSON_PROPERTY_IS_TRIGGER
- See Also:
-
JSON_PROPERTY_IS_MISSED
- See Also:
-
JSON_PROPERTY_IS_MISSED_BY_VISITOR
- See Also:
-
JSON_PROPERTY_AGENT_USERPIC
- See Also:
-
JSON_PROPERTY_RECEIVED_FROM
- See Also:
-
JSON_PROPERTY_FILE
- See Also:
-
JSON_PROPERTY_FROM
- See Also:
-
JSON_PROPERTY_TO
- See Also:
-
JSON_PROPERTY_REPLY_TO
- See Also:
-
JSON_PROPERTY_CC
- See Also:
-
JSON_PROPERTY_BCC
- See Also:
-
JSON_PROPERTY_SOURCE_MESSAGE_ID
- See Also:
-
JSON_PROPERTY_FORWARDED_TO_SOURCE_STATUS
- See Also:
-
JSON_PROPERTY_INTEGRATIONS
- See Also:
-
JSON_PROPERTY_IS_BOT
- See Also:
-
JSON_PROPERTY_ATTACHMENTS
- See Also:
-
-
Constructor Details
-
ConversationsMessage
public ConversationsMessage()
-
-
Method Details
-
id
-
getId
Message ID. It can be used for further manipulations with the message.- Returns:
- id
-
setId
-
type
-
getType
`\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages.- Returns:
- type
-
setType
-
text
-
getText
Message text or name of the attached file- Returns:
- text
-
setText
-
subject
-
getSubject
The subject line of the email message (only for messages sent to email threads).- Returns:
- subject
-
setSubject
-
html
-
getHtml
The HTML content of the message.- Returns:
- html
-
setHtml
-
rawUnsafeHtml
-
getRawUnsafeHtml
Unescaped HTML content of the message (may include unsafe HTML).- Returns:
- rawUnsafeHtml
-
setRawUnsafeHtml
-
visitorId
-
getVisitorId
visitor’s ID- Returns:
- visitorId
-
setVisitorId
-
agentId
-
getAgentId
ID of the agent on whose behalf the message was sent (only in messages sent by an agent).- Returns:
- agentId
-
setAgentId
-
agentName
-
getAgentName
Agent’s name as displayed to the visitor. Only in the messages sent by an agent.- Returns:
- agentName
-
setAgentName
-
createdAt
-
getCreatedAt
Timestamp in milliseconds. minimum: 0- Returns:
- createdAt
-
setCreatedAt
-
isPushed
-
getIsPushed
`true` for pushed messages- Returns:
- isPushed
-
setIsPushed
-
isTrigger
-
getIsTrigger
`true` for automatic messages from “Targeted chats & triggers” and API (https://developers.brevo.com/docs/javascript-api-reference#sendautomessage)- Returns:
- isTrigger
-
setIsTrigger
-
isMissed
-
getIsMissed
`true` for missed and offline messages.- Returns:
- isMissed
-
setIsMissed
-
isMissedByVisitor
-
getIsMissedByVisitor
`true` for unread agent’s messages in finished chats.- Returns:
- isMissedByVisitor
-
setIsMissedByVisitor
-
agentUserpic
-
getAgentUserpic
Only set if the agent has uploaded a profile picture.- Returns:
- agentUserpic
-
setAgentUserpic
-
receivedFrom
-
getReceivedFrom
In two-way integrations, messages sent via REST API can be marked with receivedFrom property and then filtered out when received in a webhook to avoid infinite loop.- Returns:
- receivedFrom
-
setReceivedFrom
-
_file
-
getFile
Get _file- Returns:
- _file
-
setFile
-
from
-
getFrom
Get from- Returns:
- from
-
setFrom
-
to
-
addToItem
-
getTo
An array containing details of the recipients (applicable only to messages in email threads).- Returns:
- to
-
setTo
-
replyTo
-
getReplyTo
Get replyTo- Returns:
- replyTo
-
setReplyTo
-
cc
-
addCcItem
-
getCc
An array containing details of the carbon copy (CC) recipients (applicable only to messages in email threads).- Returns:
- cc
-
setCc
-
bcc
-
addBccItem
-
getBcc
An array containing details of the blind carbon copy (BCC) recipients (applicable only to messages in email threads).- Returns:
- bcc
-
setBcc
-
sourceMessageId
-
getSourceMessageId
The ID of the message assigned by the integration source.- Returns:
- sourceMessageId
-
setSourceMessageId
-
forwardedToSourceStatus
public ConversationsMessage forwardedToSourceStatus(@Nullable ConversationsMessageForwardedToSourceStatus forwardedToSourceStatus) -
getForwardedToSourceStatus
Get forwardedToSourceStatus- Returns:
- forwardedToSourceStatus
-
setForwardedToSourceStatus
public void setForwardedToSourceStatus(@Nullable ConversationsMessageForwardedToSourceStatus forwardedToSourceStatus) -
integrations
-
getIntegrations
Integration details.- Returns:
- integrations
-
setIntegrations
-
isBot
-
getIsBot
`true` for automated messages generated by an AI bot.- Returns:
- isBot
-
setIsBot
-
attachments
public ConversationsMessage attachments(@Nullable List<ConversationsMessageAttachmentsInner> attachments) -
addAttachmentsItem
public ConversationsMessage addAttachmentsItem(ConversationsMessageAttachmentsInner attachmentsItem) -
getAttachments
An array of file attachments.- Returns:
- attachments
-
setAttachments
-
equals
-
hashCode
public int hashCode() -
toString
-
toUrlQueryString
Convert the instance into URL query string.- Returns:
- URL query string
-
toUrlQueryString
Convert the instance into URL query string.- Parameters:
prefix- prefix of the query string- Returns:
- URL query string
-