We will be winding down Google Business Messages on July 31, 2024. Read more
here.
SuggestionResponse
Stay organized with collections
Save and categorize content based on your preferences.
A response initiated when a user taps a suggestion.
| JSON representation |
{
"message": string,
"postbackData": string,
"createTime": string,
"text": string,
"type": enum (SuggestionType)
} |
| Fields |
message |
string
The message that contained the suggestions. Resolves to "conversations/{conversationId}/messages/{messageId}", where {conversationId} is the unique ID for the conversation and {messageId} is the unique ID for the message.
|
postbackData |
string
The base64-encoded payload that the agent receives when a user taps the suggestion.
|
createTime |
string (Timestamp format)
The time that user tapped the suggestion. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
|
text |
string
The user-visible text of the suggestion that the user tapped.
|
type |
enum (SuggestionType)
The type of suggestion that the user tapped.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-14 UTC."],[[["\u003cp\u003eA SuggestionResponse is triggered when a user interacts with a suggestion provided in a Business Messages conversation.\u003c/p\u003e\n"],["\u003cp\u003eIt contains essential information such as the original message, encoded agent payload, timestamp of the interaction, displayed suggestion text, and the type of suggestion used.\u003c/p\u003e\n"],["\u003cp\u003eThe response data is structured in JSON format, including fields like \u003ccode\u003emessage\u003c/code\u003e, \u003ccode\u003epostbackData\u003c/code\u003e, \u003ccode\u003ecreateTime\u003c/code\u003e, \u003ccode\u003etext\u003c/code\u003e, and \u003ccode\u003etype\u003c/code\u003e with specific data types and descriptions for each.\u003c/p\u003e\n"]]],[],null,["# SuggestionResponse\n\nA response initiated when a user taps a suggestion.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"message\": string, \"postbackData\": string, \"createTime\": string, \"text\": string, \"type\": enum (/business-communications/business-messages/reference/rest/v1/SuggestionType) } ``` |\n\n| Fields ||\n|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `message` | `string` The message that contained the suggestions. Resolves to \"conversations/{conversationId}/messages/{messageId}\", where {conversationId} is the unique ID for the conversation and {messageId} is the unique ID for the message. |\n| `postbackData` | `string` The base64-encoded payload that the agent receives when a user taps the suggestion. |\n| `createTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp)` format)` The time that user tapped the suggestion. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: `\"2014-10-02T15:01:23Z\"` and `\"2014-10-02T15:01:23.045123456Z\"`. |\n| `text` | `string` The user-visible text of the suggestion that the user tapped. |\n| `type` | `enum (`[SuggestionType](/business-communications/business-messages/reference/rest/v1/SuggestionType)`)` The type of suggestion that the user tapped. |"]]