| id |
String |
The message ID, generated automatically. |
|
| authorId |
String |
The ID of the message's author. |
|
| role |
String |
The role of the individual posting the message. See RoleEnum for available values. |
|
| type |
String |
The message type. See MessageTypeEnum for available values. |
|
| source |
Source |
The source of the message. |
[optional] |
| name |
String |
The display name of the message author. |
|
| text |
String |
The message text. Required for text messages. |
|
| email |
String |
The email address of the message author. |
[optional] |
| avatarUrl |
String |
The URL of the desired message avatar image. |
|
| received |
Float |
The unix timestamp of the moment the message was received. |
|
| mediaUrl |
String |
The mediaUrl for the message. Required for image/file messages. |
[optional] |
| mediaType |
String |
The mediaType for the message. Required for image/file messages. |
[optional] |
| altText |
String |
An optional description of the image or the file for accessibility purposes. The field will be saved by default with the file name as the value. |
[optional] |
| metadata |
Object |
Flat JSON object containing any custom properties associated with the message. |
[optional] |
| items |
Array<MessageItem> |
The items in the message list. Required for carousel and list messages. |
[optional] |
| actions |
Array<Action> |
The actions in the message. |
[optional] |
| payload |
String |
The payload of a reply action, if applicable. |
[optional] |
| displaySettings |
DisplaySettings |
Settings to adjust the carousel layout. See Display Settings. |
[optional] |
| blockChatInput |
BOOLEAN |
Indicates if the Web SDK chat input should be blocked. Defaults to false. Only for form messages. |
[optional] |
| fields |
Array<Field> |
The fields in the form. Required for form and formResponse messages. |
[optional] |
| submitted |
BOOLEAN |
Indicates if the form was submitted. Generated automatically. |
[optional] |
| quotedMessage |
QuotedMessage |
The form message a formResponse message responds to. Required for formResponse messages. |
[optional] |
| textFallback |
String |
The text fallback displayed in channels that do not support form messages. Only for formResponse messages. Generated automatically. |
[optional] |
| coordinates |
Coordinates |
Data representing the location being sent in the message. |
[optional] |
| location |
Location |
Additional information about the location being sent in the message. |
[optional] |