Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Important
- This is a preview feature.
- Preview features aren’t meant for production use and might have restricted functionality. These features are subject to supplemental terms of use, and are available before an official release so that customers can get early access and provide feedback.
An interface that describes the data returned by the executeEvent and executePrompt methods.
Properties
The following table describes the MCSResponse properties. Only the type property will always be present.
| Name | Type | Description |
|---|---|---|
type |
string |
Required. The type of the response. |
id |
string |
Unique identifier for the response. |
locale |
string |
Locale information (e.g., language or region). |
replyToId |
string |
ID of the message this is replying to. |
timestamp |
string |
Timestamp of the response. |
speak |
string |
Text to be spoken by a speech synthesizer. |
text |
string |
Text content of the response. |
textFormat |
plain | markdown | xml |
Format of the text content. |
suggestedActions |
{ actions: any[]; to?: string[] } |
Suggested actions for the user to take. |
value |
unknown |
Custom payload or data. |
valueType |
string |
Type of the value payload. |
name |
string |
Name of the response or action. |
attachmentLayout |
list | carousel |
Layout style for displaying attachments. |
attachments |
Attachment[] | Array of attachments included in the response. |
Attachment Interface
| Name | Type | Description |
|---|---|---|
content |
unknown |
Required. The content of the attachment. |
contentType |
string |
Describes the type of content. |