Package software.xdev.brevo.model

Class ConversationsMessage

java.lang.Object

software.xdev.brevo.model.ConversationsMessage

public class ConversationsMessage
extends Object

a Conversations message

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ConversationsMessage.TypeEnum	`\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_AGENT_ID
static final String	JSON_PROPERTY_AGENT_NAME
static final String	JSON_PROPERTY_AGENT_USERPIC
static final String	JSON_PROPERTY_ATTACHMENTS
static final String	JSON_PROPERTY_BCC
static final String	JSON_PROPERTY_CC
static final String	JSON_PROPERTY_CREATED_AT
static final String	JSON_PROPERTY_FILE
static final String	JSON_PROPERTY_FORWARDED_TO_SOURCE_STATUS
static final String	JSON_PROPERTY_FROM
static final String	JSON_PROPERTY_HTML
static final String	JSON_PROPERTY_ID
static final String	JSON_PROPERTY_INTEGRATIONS
static final String	JSON_PROPERTY_IS_BOT
static final String	JSON_PROPERTY_IS_MISSED
static final String	JSON_PROPERTY_IS_MISSED_BY_VISITOR
static final String	JSON_PROPERTY_IS_PUSHED
static final String	JSON_PROPERTY_IS_TRIGGER
static final String	JSON_PROPERTY_RAW_UNSAFE_HTML
static final String	JSON_PROPERTY_RECEIVED_FROM
static final String	JSON_PROPERTY_REPLY_TO
static final String	JSON_PROPERTY_SOURCE_MESSAGE_ID
static final String	JSON_PROPERTY_SUBJECT
static final String	JSON_PROPERTY_TEXT
static final String	JSON_PROPERTY_TO
static final String	JSON_PROPERTY_TYPE
static final String	JSON_PROPERTY_VISITOR_ID

Constructor Summary

Constructors

Constructor	Description
ConversationsMessage()

Method Summary

Modifier and Type	Method	Description
ConversationsMessage	_file(ConversationsMessageFile _file)
ConversationsMessage	addAttachmentsItem(ConversationsMessageAttachmentsInner attachmentsItem)
ConversationsMessage	addBccItem(ConversationsMessageToInner bccItem)
ConversationsMessage	addCcItem(ConversationsMessageToInner ccItem)
ConversationsMessage	addToItem(ConversationsMessageToInner toItem)
ConversationsMessage	agentId(String agentId)
ConversationsMessage	agentName(String agentName)
ConversationsMessage	agentUserpic(String agentUserpic)
ConversationsMessage	attachments(List<ConversationsMessageAttachmentsInner> attachments)
ConversationsMessage	bcc(List<ConversationsMessageToInner> bcc)
ConversationsMessage	cc(List<ConversationsMessageToInner> cc)
ConversationsMessage	createdAt(Long createdAt)
boolean	equals(Object o)
ConversationsMessage	forwardedToSourceStatus(ConversationsMessageForwardedToSourceStatus forwardedToSourceStatus)
ConversationsMessage	from(ConversationsMessageFrom from)
String	getAgentId()	ID of the agent on whose behalf the message was sent (only in messages sent by an agent).
String	getAgentName()	Agent’s name as displayed to the visitor.
String	getAgentUserpic()	Only set if the agent has uploaded a profile picture.
List<ConversationsMessageAttachmentsInner>	getAttachments()	An array of file attachments.
List<ConversationsMessageToInner>	getBcc()	An array containing details of the blind carbon copy (BCC) recipients (applicable only to messages in email threads).
List<ConversationsMessageToInner>	getCc()	An array containing details of the carbon copy (CC) recipients (applicable only to messages in email threads).
Long	getCreatedAt()	Timestamp in milliseconds.
ConversationsMessageFile	getFile()	Get _file
ConversationsMessageForwardedToSourceStatus	getForwardedToSourceStatus()	Get forwardedToSourceStatus
ConversationsMessageFrom	getFrom()	Get from
String	getHtml()	The HTML content of the message.
String	getId()	Message ID.
Object	getIntegrations()	Integration details.
Boolean	getIsBot()	`true` for automated messages generated by an AI bot.
Boolean	getIsMissed()	`true` for missed and offline messages.
Boolean	getIsMissedByVisitor()	`true` for unread agent’s messages in finished chats.
Boolean	getIsPushed()	`true` for pushed messages
Boolean	getIsTrigger()	`true` for automatic messages from “Targeted chats & triggers” and API (https://developers.brevo.com/docs/javascript-api-reference#sendautomessage)
String	getRawUnsafeHtml()	Unescaped HTML content of the message (may include unsafe HTML).
String	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.
ConversationsMessageReplyTo	getReplyTo()	Get replyTo
String	getSourceMessageId()	The ID of the message assigned by the integration source.
String	getSubject()	The subject line of the email message (only for messages sent to email threads).
String	getText()	Message text or name of the attached file
List<ConversationsMessageToInner>	getTo()	An array containing details of the recipients (applicable only to messages in email threads).
ConversationsMessage.TypeEnum	getType()	`\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages.
String	getVisitorId()	visitor’s ID
int	hashCode()
ConversationsMessage	html(String html)
ConversationsMessage	id(String id)
ConversationsMessage	integrations(Object integrations)
ConversationsMessage	isBot(Boolean isBot)
ConversationsMessage	isMissed(Boolean isMissed)
ConversationsMessage	isMissedByVisitor(Boolean isMissedByVisitor)
ConversationsMessage	isPushed(Boolean isPushed)
ConversationsMessage	isTrigger(Boolean isTrigger)
ConversationsMessage	rawUnsafeHtml(String rawUnsafeHtml)
ConversationsMessage	receivedFrom(String receivedFrom)
ConversationsMessage	replyTo(ConversationsMessageReplyTo replyTo)
void	setAgentId(String agentId)
void	setAgentName(String agentName)
void	setAgentUserpic(String agentUserpic)
void	setAttachments(List<ConversationsMessageAttachmentsInner> attachments)
void	setBcc(List<ConversationsMessageToInner> bcc)
void	setCc(List<ConversationsMessageToInner> cc)
void	setCreatedAt(Long createdAt)
void	setFile(ConversationsMessageFile _file)
void	setForwardedToSourceStatus(ConversationsMessageForwardedToSourceStatus forwardedToSourceStatus)
void	setFrom(ConversationsMessageFrom from)
void	setHtml(String html)
void	setId(String id)
void	setIntegrations(Object integrations)
void	setIsBot(Boolean isBot)
void	setIsMissed(Boolean isMissed)
void	setIsMissedByVisitor(Boolean isMissedByVisitor)
void	setIsPushed(Boolean isPushed)
void	setIsTrigger(Boolean isTrigger)
void	setRawUnsafeHtml(String rawUnsafeHtml)
void	setReceivedFrom(String receivedFrom)
void	setReplyTo(ConversationsMessageReplyTo replyTo)
void	setSourceMessageId(String sourceMessageId)
void	setSubject(String subject)
void	setText(String text)
void	setTo(List<ConversationsMessageToInner> to)
void	setType(ConversationsMessage.TypeEnum type)
void	setVisitorId(String visitorId)
ConversationsMessage	sourceMessageId(String sourceMessageId)
ConversationsMessage	subject(String subject)
ConversationsMessage	text(String text)
ConversationsMessage	to(List<ConversationsMessageToInner> to)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
ConversationsMessage	type(ConversationsMessage.TypeEnum type)
ConversationsMessage	visitorId(String visitorId)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_ID

public static final String JSON_PROPERTY_ID

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_TEXT

public static final String JSON_PROPERTY_TEXT

See Also:

• Constant Field Values

JSON_PROPERTY_SUBJECT

public static final String JSON_PROPERTY_SUBJECT

See Also:

• Constant Field Values

JSON_PROPERTY_HTML

public static final String JSON_PROPERTY_HTML

See Also:

• Constant Field Values

JSON_PROPERTY_RAW_UNSAFE_HTML

public static final String JSON_PROPERTY_RAW_UNSAFE_HTML

See Also:

• Constant Field Values

JSON_PROPERTY_VISITOR_ID

public static final String JSON_PROPERTY_VISITOR_ID

See Also:

• Constant Field Values

JSON_PROPERTY_AGENT_ID

public static final String JSON_PROPERTY_AGENT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_AGENT_NAME

public static final String JSON_PROPERTY_AGENT_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_CREATED_AT

public static final String JSON_PROPERTY_CREATED_AT

See Also:

• Constant Field Values

JSON_PROPERTY_IS_PUSHED

public static final String JSON_PROPERTY_IS_PUSHED

See Also:

• Constant Field Values

JSON_PROPERTY_IS_TRIGGER

public static final String JSON_PROPERTY_IS_TRIGGER

See Also:

• Constant Field Values

JSON_PROPERTY_IS_MISSED

public static final String JSON_PROPERTY_IS_MISSED

See Also:

• Constant Field Values

JSON_PROPERTY_IS_MISSED_BY_VISITOR

public static final String JSON_PROPERTY_IS_MISSED_BY_VISITOR

See Also:

• Constant Field Values

JSON_PROPERTY_AGENT_USERPIC

public static final String JSON_PROPERTY_AGENT_USERPIC

See Also:

• Constant Field Values

JSON_PROPERTY_RECEIVED_FROM

public static final String JSON_PROPERTY_RECEIVED_FROM

See Also:

• Constant Field Values

JSON_PROPERTY_FILE

public static final String JSON_PROPERTY_FILE

See Also:

• Constant Field Values

JSON_PROPERTY_FROM

public static final String JSON_PROPERTY_FROM

See Also:

• Constant Field Values

JSON_PROPERTY_TO

public static final String JSON_PROPERTY_TO

See Also:

• Constant Field Values

JSON_PROPERTY_REPLY_TO

public static final String JSON_PROPERTY_REPLY_TO

See Also:

• Constant Field Values

JSON_PROPERTY_CC

public static final String JSON_PROPERTY_CC

See Also:

• Constant Field Values

JSON_PROPERTY_BCC

public static final String JSON_PROPERTY_BCC

See Also:

• Constant Field Values

JSON_PROPERTY_SOURCE_MESSAGE_ID

public static final String JSON_PROPERTY_SOURCE_MESSAGE_ID

See Also:

• Constant Field Values

JSON_PROPERTY_FORWARDED_TO_SOURCE_STATUS

public static final String JSON_PROPERTY_FORWARDED_TO_SOURCE_STATUS

See Also:

• Constant Field Values

JSON_PROPERTY_INTEGRATIONS

public static final String JSON_PROPERTY_INTEGRATIONS

See Also:

• Constant Field Values

JSON_PROPERTY_IS_BOT

public static final String JSON_PROPERTY_IS_BOT

See Also:

• Constant Field Values

JSON_PROPERTY_ATTACHMENTS

public static final String JSON_PROPERTY_ATTACHMENTS

See Also:

• Constant Field Values

Constructor Details

ConversationsMessage

public ConversationsMessage()

Method Details

id

public ConversationsMessage id(@Nullable
 String id)

getId

@Nullable
public String getId()

Message ID. It can be used for further manipulations with the message.

Returns:

id

setId

public void setId(@Nullable
 String id)

type

public ConversationsMessage type(@Nullable
 ConversationsMessage.TypeEnum type)

getType

@Nullable
public ConversationsMessage.TypeEnum getType()

`\"agent\"` for agents’ messages, `\"visitor\"` for visitors’ messages.

Returns:

type

setType

public void setType(@Nullable
 ConversationsMessage.TypeEnum type)

text

public ConversationsMessage text(@Nullable
 String text)

getText

@Nullable
public String getText()

Message text or name of the attached file

Returns:

text

setText

public void setText(@Nullable
 String text)

subject

public ConversationsMessage subject(@Nullable
 String subject)

getSubject

@Nullable
public String getSubject()

The subject line of the email message (only for messages sent to email threads).

Returns:

subject

setSubject

public void setSubject(@Nullable
 String subject)

html

public ConversationsMessage html(@Nullable
 String html)

getHtml

@Nullable
public String getHtml()

The HTML content of the message.

Returns:

html

setHtml

public void setHtml(@Nullable
 String html)

rawUnsafeHtml

public ConversationsMessage rawUnsafeHtml(@Nullable
 String rawUnsafeHtml)

getRawUnsafeHtml

@Nullable
public String getRawUnsafeHtml()

Unescaped HTML content of the message (may include unsafe HTML).

Returns:

rawUnsafeHtml

setRawUnsafeHtml

public void setRawUnsafeHtml(@Nullable
 String rawUnsafeHtml)

visitorId

public ConversationsMessage visitorId(@Nullable
 String visitorId)

getVisitorId

@Nullable
public String getVisitorId()

visitor’s ID

Returns:

visitorId

setVisitorId

public void setVisitorId(@Nullable
 String visitorId)

agentId

public ConversationsMessage agentId(@Nullable
 String agentId)

getAgentId

@Nullable
public String getAgentId()

ID of the agent on whose behalf the message was sent (only in messages sent by an agent).

Returns:

agentId

setAgentId

public void setAgentId(@Nullable
 String agentId)

agentName

public ConversationsMessage agentName(@Nullable
 String agentName)

getAgentName

@Nullable
public String getAgentName()

Agent’s name as displayed to the visitor. Only in the messages sent by an agent.

Returns:

agentName

setAgentName

public void setAgentName(@Nullable
 String agentName)

createdAt

public ConversationsMessage createdAt(@Nullable
 Long createdAt)

getCreatedAt

@Nullable
public Long getCreatedAt()

Timestamp in milliseconds. minimum: 0

Returns:

createdAt

setCreatedAt

public void setCreatedAt(@Nullable
 Long createdAt)

isPushed

public ConversationsMessage isPushed(@Nullable
 Boolean isPushed)

getIsPushed

@Nullable
public Boolean getIsPushed()

`true` for pushed messages

Returns:

isPushed

setIsPushed

public void setIsPushed(@Nullable
 Boolean isPushed)

isTrigger

public ConversationsMessage isTrigger(@Nullable
 Boolean isTrigger)

getIsTrigger

@Nullable
public Boolean getIsTrigger()

`true` for automatic messages from “Targeted chats & triggers” and API (https://developers.brevo.com/docs/javascript-api-reference#sendautomessage)

Returns:

isTrigger

setIsTrigger

public void setIsTrigger(@Nullable
 Boolean isTrigger)

isMissed

public ConversationsMessage isMissed(@Nullable
 Boolean isMissed)

getIsMissed

@Nullable
public Boolean getIsMissed()

`true` for missed and offline messages.

Returns:

isMissed

setIsMissed

public void setIsMissed(@Nullable
 Boolean isMissed)

isMissedByVisitor

public ConversationsMessage isMissedByVisitor(@Nullable
 Boolean isMissedByVisitor)

getIsMissedByVisitor

@Nullable
public Boolean getIsMissedByVisitor()

`true` for unread agent’s messages in finished chats.

Returns:

isMissedByVisitor

setIsMissedByVisitor

public void setIsMissedByVisitor(@Nullable
 Boolean isMissedByVisitor)

agentUserpic

public ConversationsMessage agentUserpic(@Nullable
 String agentUserpic)

getAgentUserpic

@Nullable
public String getAgentUserpic()

Only set if the agent has uploaded a profile picture.

Returns:

agentUserpic

setAgentUserpic

public void setAgentUserpic(@Nullable
 String agentUserpic)

receivedFrom

public ConversationsMessage receivedFrom(@Nullable
 String receivedFrom)

getReceivedFrom

@Nullable
public String 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

public void setReceivedFrom(@Nullable
 String receivedFrom)

_file

public ConversationsMessage _file(@Nullable
 ConversationsMessageFile _file)

getFile

@Nullable
public ConversationsMessageFile getFile()

Get _file

Returns:

_file

setFile

public void setFile(@Nullable
 ConversationsMessageFile _file)

from

public ConversationsMessage from(@Nullable
 ConversationsMessageFrom from)

getFrom

@Nullable
public ConversationsMessageFrom getFrom()

Get from

Returns:

from

setFrom

public void setFrom(@Nullable
 ConversationsMessageFrom from)

to

public ConversationsMessage to(@Nullable
 List<ConversationsMessageToInner> to)

addToItem

public ConversationsMessage addToItem(ConversationsMessageToInner toItem)

getTo

@Nullable
public List<ConversationsMessageToInner> getTo()

An array containing details of the recipients (applicable only to messages in email threads).

Returns:

to

setTo

public void setTo(@Nullable
 List<ConversationsMessageToInner> to)

replyTo

public ConversationsMessage replyTo(@Nullable
 ConversationsMessageReplyTo replyTo)

getReplyTo

@Nullable
public ConversationsMessageReplyTo getReplyTo()

Get replyTo

Returns:

replyTo

setReplyTo

public void setReplyTo(@Nullable
 ConversationsMessageReplyTo replyTo)

cc

public ConversationsMessage cc(@Nullable
 List<ConversationsMessageToInner> cc)

addCcItem

public ConversationsMessage addCcItem(ConversationsMessageToInner ccItem)

getCc

@Nullable
public List<ConversationsMessageToInner> getCc()

An array containing details of the carbon copy (CC) recipients (applicable only to messages in email threads).

Returns:

cc

setCc

public void setCc(@Nullable
 List<ConversationsMessageToInner> cc)

bcc

public ConversationsMessage bcc(@Nullable
 List<ConversationsMessageToInner> bcc)

addBccItem

public ConversationsMessage addBccItem(ConversationsMessageToInner bccItem)

getBcc

@Nullable
public List<ConversationsMessageToInner> getBcc()

An array containing details of the blind carbon copy (BCC) recipients (applicable only to messages in email threads).

Returns:

bcc

setBcc

public void setBcc(@Nullable
 List<ConversationsMessageToInner> bcc)

sourceMessageId

public ConversationsMessage sourceMessageId(@Nullable
 String sourceMessageId)

getSourceMessageId

@Nullable
public String getSourceMessageId()

The ID of the message assigned by the integration source.

Returns:

sourceMessageId

setSourceMessageId

public void setSourceMessageId(@Nullable
 String sourceMessageId)

forwardedToSourceStatus

public ConversationsMessage forwardedToSourceStatus(@Nullable
 ConversationsMessageForwardedToSourceStatus forwardedToSourceStatus)

getForwardedToSourceStatus

@Nullable
public ConversationsMessageForwardedToSourceStatus getForwardedToSourceStatus()

Get forwardedToSourceStatus

Returns:

forwardedToSourceStatus

setForwardedToSourceStatus

public void setForwardedToSourceStatus(@Nullable
 ConversationsMessageForwardedToSourceStatus forwardedToSourceStatus)

integrations

public ConversationsMessage integrations(@Nullable
 Object integrations)

getIntegrations

@Nullable
public Object getIntegrations()

Integration details.

Returns:

integrations

setIntegrations

public void setIntegrations(@Nullable
 Object integrations)

isBot

public ConversationsMessage isBot(@Nullable
 Boolean isBot)

getIsBot

@Nullable
public Boolean getIsBot()

`true` for automated messages generated by an AI bot.

Returns:

isBot

setIsBot

public void setIsBot(@Nullable
 Boolean isBot)

attachments

public ConversationsMessage attachments(@Nullable
 List<ConversationsMessageAttachmentsInner> attachments)

addAttachmentsItem

public ConversationsMessage addAttachmentsItem(ConversationsMessageAttachmentsInner attachmentsItem)

getAttachments

@Nullable
public List<ConversationsMessageAttachmentsInner> getAttachments()

An array of file attachments.

Returns:

attachments

setAttachments

public void setAttachments(@Nullable
 List<ConversationsMessageAttachmentsInner> attachments)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toUrlQueryString

public String toUrlQueryString()

Convert the instance into URL query string.

Returns:

URL query string

toUrlQueryString

public String toUrlQueryString(String prefix)

Convert the instance into URL query string.

Parameters:

prefix - prefix of the query string

Returns:

URL query string