Class GoogleCloudDialogflowV2beta1WebhookResponse
The response message for a webhook call. This response is validated by the Dialogflow server. If validation
fails, an error will be returned in the QueryResult.diagnostic_info field. Setting JSON fields to an empty value
with the wrong type is a common error. To avoid this error: - Use ""
for empty strings - Use {}
or null
for empty objects - Use []
or null
for empty arrays For more information, see the Protocol Buffers Language
Guide.
Implements
Inherited Members
Namespace: Google.Apis.Dialogflow.v3beta1.Data
Assembly: Google.Apis.Dialogflow.v3beta1.dll
Syntax
public class GoogleCloudDialogflowV2beta1WebhookResponse : IDirectResponseSchema
Properties
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
EndInteraction
Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.
Declaration
[JsonProperty("endInteraction")]
public virtual bool? EndInteraction { get; set; }
Property Value
Type | Description |
---|---|
bool? |
FollowupEventInput
Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the fulfillment_text
,
fulfillment_messages
, and payload
fields.
Declaration
[JsonProperty("followupEventInput")]
public virtual GoogleCloudDialogflowV2beta1EventInput FollowupEventInput { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudDialogflowV2beta1EventInput |
FulfillmentMessages
Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.
Declaration
[JsonProperty("fulfillmentMessages")]
public virtual IList<GoogleCloudDialogflowV2beta1IntentMessage> FulfillmentMessages { get; set; }
Property Value
Type | Description |
---|---|
IList<GoogleCloudDialogflowV2beta1IntentMessage> |
FulfillmentText
Optional. The text response message intended for the end-user. It is recommended to use
fulfillment_messages.text.text[0]
instead. When provided, Dialogflow uses this field to populate
QueryResult.fulfillment_text sent to the integration or API caller.
Declaration
[JsonProperty("fulfillmentText")]
public virtual string FulfillmentText { get; set; }
Property Value
Type | Description |
---|---|
string |
LiveAgentHandoff
Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false.
Declaration
[JsonProperty("liveAgentHandoff")]
public virtual bool? LiveAgentHandoff { get; set; }
Property Value
Type | Description |
---|---|
bool? |
OutputContexts
Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.
Declaration
[JsonProperty("outputContexts")]
public virtual IList<GoogleCloudDialogflowV2beta1Context> OutputContexts { get; set; }
Property Value
Type | Description |
---|---|
IList<GoogleCloudDialogflowV2beta1Context> |
Payload
Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the Google Assistant integration for rich response messages. See the format definition at Google Assistant Dialogflow webhook format
Declaration
[JsonProperty("payload")]
public virtual IDictionary<string, object> Payload { get; set; }
Property Value
Type | Description |
---|---|
IDictionary<string, object> |
SessionEntityTypes
Optional. Additional session entity types to replace or extend developer entity types with. The entity
synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the
session entity types that have been set using detectIntent
, streamingDetectIntent
or SessionEntityType
management methods.
Declaration
[JsonProperty("sessionEntityTypes")]
public virtual IList<GoogleCloudDialogflowV2beta1SessionEntityType> SessionEntityTypes { get; set; }
Property Value
Type | Description |
---|---|
IList<GoogleCloudDialogflowV2beta1SessionEntityType> |
Source
Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_source sent to the integration or API caller.
Declaration
[JsonProperty("source")]
public virtual string Source { get; set; }
Property Value
Type | Description |
---|---|
string |