Components
CustomMessageResponse
A custom message is a pre-configured message delivered by an agent as a greeting at the beginning of a conversation. Multiple agents can use the same custom mesasage. A custom message has one or more rules defined, which allow for different messages to be dynamically selected and delivered at runtime based on the current time and either date or day of the week.
Example Usage
Fields
Field | Type | Required | Description | Example |
---|---|---|---|---|
name | string | TRUE | The name of the custom message | |
text | string | TRUE | The text of the custom message | |
label | string | FALSE | The label of the custom message | |
rules | components.CustomMessageRule[] | FALSE | Rules for time-specific message variants | |
id | number | TRUE | The ID of the custom message | |
updatedAt | Date | TRUE | Timestamp of the most recent update to the custom message | |
agentCount | number | FALSE | The number of agents using the custom message | |
lastUpdatedBy | string | TRUE | The email address of the user who most recently updated the custom message | user@email.com |
type | string | FALSE | N/A |