ConversationMessageBccsByConversationId |
Get a messageRetrieve a single message by its ID.
Catalog: Brevo
Schema: Conversations
This is a read-only table function. The Sendinblue API may not support changing the data or the Invantive UniversalSQL driver for Sendinblue does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Sendinblue API.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function ConversationMessageBccsByConversationId. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
id |
|
☑ |
|
ID of the message |
Columns of Table Function
The columns of the table function ConversationMessageBccsByConversationId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
agentId |
varchar2 |
|
☐ |
ID of the agent on whose behalf the message was sent (only in messages sent by an agent). |
agentName |
varchar2 |
|
☐ |
Agent’s name as displayed to the visitor. Only in the messages sent by an agent. |
agentUserpic |
varchar2 |
|
☐ |
Only set if the agent has uploaded a profile picture. |
createdAt |
int64 |
Creation Date |
☐ |
Timestamp in milliseconds. |
varchar2 |
Email Address |
☐ |
|
|
file_imageInfo_height |
int64 |
|
☐ |
Height of the image in pixels. |
file_imageInfo_previewLink |
varchar2 |
|
☐ |
URL of the image preview. |
file_imageInfo_width |
int64 |
|
☐ |
Width of the image in pixels. |
file_inlineId |
varchar2 |
|
☐ |
The ID of the inline file. |
file_isAllowedFileType |
char |
|
☐ |
Whether the file extension is allowed for download. |
file_isImage |
char |
|
☐ |
Whether the file is an image. |
file_isInline |
char |
|
☐ |
Whether the file is inline. |
file_isSticker |
char |
|
☐ |
Whether the file is a sticker. |
file_link |
varchar2 |
|
☐ |
URL of the file. |
file_mimeType |
varchar2 |
|
☐ |
MIME type of the file. |
file_name |
varchar2 |
|
☐ |
Name of the file. |
file_size |
int64 |
|
☐ |
Size in bytes. |
forwardedToSourceStatus_error |
varchar2 |
|
☐ |
|
forwardedToSourceStatus_isSuccess |
char |
|
☐ |
|
from_email |
varchar2 |
|
☐ |
|
from_name |
varchar2 |
|
☐ |
|
html |
varchar2 |
|
☐ |
The HTML content of the message. |
id |
varchar2 |
ID |
☐ |
Message ID. It can be used for further manipulations with the message. |
integrations |
varchar2 |
|
☐ |
Integration details. |
isBot |
char |
|
☐ |
`true` for automated messages generated by an AI bot. |
isForward |
char |
|
☐ |
‘`true` if the message is a forwarded message.’ |
isMissed |
char |
|
☐ |
`true` for missed and offline messages. |
isMissedByVisitor |
char |
|
☐ |
`true` for unread agent’s messages in finished chats. |
isPushed |
char |
|
☐ |
`true` for pushed messages |
isSentViaJsApi |
char |
|
☐ |
‘`true` if the message was sent via JavaScript API.’ |
isTrigger |
char |
|
☐ |
`true` for automatic messages from “Targeted chats & triggers” and API (https://developers.brevo.com/docs/javascript-api-reference#sendautomessage) |
messageType |
varchar2 |
|
☐ |
The type of message content (e.g. for integration-specific message types). |
name |
varchar2 |
Name |
☐ |
|
rawUnsafeHtml |
varchar2 |
|
☐ |
Unescaped HTML content of the message (may include unsafe HTML). |
receivedFrom |
varchar2 |
|
☐ |
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. |
replyTo_email |
varchar2 |
|
☐ |
|
replyTo_name |
varchar2 |
|
☐ |
|
source |
varchar2 |
|
☐ |
Source information for the message. |
sourceMessageId |
varchar2 |
|
☐ |
The ID of the message assigned by the integration source. |
subject |
varchar2 |
Subject |
☐ |
The subject line of the email message (only for messages sent to email threads). |
text |
varchar2 |
Text |
☐ |
Message text or name of the attached file |
type |
varchar2 |
Type |
☐ |
`"agent"` for agents’ messages, `"visitor"` for visitors’ messages. |
visitorId |
varchar2 |
|
☐ |
visitor’s ID |
Sendinblue API Data Model