Skip to content

Latest commit

 

History

History
42 lines (35 loc) · 3.3 KB

File metadata and controls

42 lines (35 loc) · 3.3 KB

ConversationsMessage

Properties

Name Type Description Notes
id String Message ID. It can be used for further manipulations with the message. [optional]
type TypeEnum `"agent"` for agents’ messages, `"visitor"` for visitors’ messages. [optional]
text String Message text or name of the attached file [optional]
subject String The subject line of the email message (only for messages sent to email threads). [optional]
visitorId String visitor’s ID [optional]
agentId String ID of the agent on whose behalf the message was sent (only in messages sent by an agent). [optional]
agentName String Agent’s name as displayed to the visitor. Only in the messages sent by an agent. [optional]
createdAt Long Timestamp in milliseconds. [optional]
isPushed Boolean `true` for pushed messages [optional]
isTrigger Boolean `true` for automatic messages from “Targeted chats & triggers” and API (https://developers.brevo.com/docs/javascript-api-reference#sendautomessage) [optional]
isMissed Boolean `true` for missed and offline messages. [optional]
isMissedByVisitor Boolean `true` for unread agent’s messages in finished chats. [optional]
agentUserpic String Only set if the agent has uploaded a profile picture. [optional]
receivedFrom String 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. [optional]
file ConversationsMessageFile [optional]
from ConversationsMessageFrom [optional]
to List<ConversationsMessageTo> An array containing details of the recipients (applicable only to messages in email threads). [optional]
replyTo ConversationsMessageReplyTo [optional]
cc List<ConversationsMessageTo> An array containing details of the carbon copy (CC) recipients (applicable only to messages in email threads). [optional]
bcc List<ConversationsMessageTo> An array containing details of the blind carbon copy (BCC) recipients (applicable only to messages in email threads). [optional]
sourceMessageId String The ID of the message assigned by the integration source. [optional]
forwardedToSourceStatus ConversationsMessageForwardedToSourceStatus [optional]
integrations Object Integration details. [optional]
isBot Boolean `true` for automated messages generated by an AI bot. [optional]
attachments List<ConversationsMessageAttachments> An array of file attachments. [optional]

Enum: TypeEnum

Name Value
AGENT "agent"
VISITOR "visitor"