Name | Type | Description | Notes |
---|---|---|---|
type | str | The type of message. | [default to 'template'] |
text | str | The fallback text message used when location messages are not supported by the channel. | [optional] [readonly] |
actions | list[ActionSubset] | An array of objects representing the actions associated with the message. The array length is limited by the third party channel. | [optional] |
payload | str | The payload of a reply button response message. | [optional] |
items | list[Item] | An array of objects representing the items associated with the message. Only present in carousel and list type messages. | |
display_settings | CarouselMessageDisplaySettings | [optional] | |
media_url | str | The URL for media, such as an image, attached to the message. | |
media_size | float | The size of the media in bytes. | [optional] [readonly] |
media_type | str | The type of media. | [optional] [readonly] |
alt_text | str | An optional description of the image for accessibility purposes. The field will be saved by default with the file name as the value. | [optional] |
attachment_id | str | An identifier used by Sunshine Conversations for internal purposes. | [optional] |
submitted | bool | Flag which states whether the form is submitted. | [optional] [readonly] |
block_chat_input | bool | true if the message should block the chat input on Web Messenger. | [optional] |
fields | list[FormResponseMessageField] | Array of field objects that contain the submitted fields. | |
text_fallback | str | A string containing the `label: value` of all fields, each separated by a newline character. | [optional] [readonly] |
coordinates | LocationMessageCoordinates | ||
location | LocationMessageLocation | [optional] | |
template | object | The whatsapp template message to send. For more information, consult the guide. `schema` must be set to `whatsapp`. |