Google Cloud Dialogflow v2beta1 API - Class WebhookResponse (1.0.0-beta10)

public sealed class WebhookResponse : IMessage<WebhookResponse>, IEquatable<WebhookResponse>, IDeepCloneable<WebhookResponse>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Dialogflow v2beta1 API class WebhookResponse.

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][google.cloud.dialogflow.v2beta1.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.

Inheritance

object > WebhookResponse

Implements

IMessage WebhookResponse, IEquatable WebhookResponse, IDeepCloneable WebhookResponse, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Dialogflow.V2Beta1

Assembly

Google.Cloud.Dialogflow.V2Beta1.dll

Constructors

WebhookResponse()

public WebhookResponse()

WebhookResponse(WebhookResponse)

public WebhookResponse(WebhookResponse other)

Parameter
Name	Description
`other`	`WebhookResponse`

Properties

EndInteraction

public bool EndInteraction { get; set; }

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.

Property Value
Type	Description
`bool`

FollowupEventInput

public EventInput FollowupEventInput { get; set; }

Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the fulfillment_text, fulfillment_messages, and payload fields.

Property Value
Type	Description
`EventInput`

FulfillmentMessages

public RepeatedField<Intent.Types.Message> FulfillmentMessages { get; }

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate [QueryResult.fulfillment_messages][google.cloud.dialogflow.v2beta1.QueryResult.fulfillment_messages] sent to the integration or API caller.

Property Value
Type	Description
`RepeatedFieldIntentTypesMessage`

FulfillmentText

public string FulfillmentText { get; set; }

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][google.cloud.dialogflow.v2beta1.QueryResult.fulfillment_text] sent to the integration or API caller.

Property Value
Type	Description
`string`

LiveAgentHandoff

public bool LiveAgentHandoff { get; set; }

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.

Property Value
Type	Description
`bool`

OutputContexts

public RepeatedField<Context> OutputContexts { get; }

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][google.cloud.dialogflow.v2beta1.QueryResult.output_contexts] sent to the integration or API caller.

Property Value
Type	Description
`RepeatedFieldContext`

Payload

public Struct Payload { get; set; }

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][google.cloud.dialogflow.v2beta1.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

Property Value
Type	Description
`Struct`

SessionEntityTypes

public RepeatedField<SessionEntityType> SessionEntityTypes { get; }

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][google.cloud.dialogflow.v2beta1.SessionEntityType] management methods.

Property Value
Type	Description
`RepeatedFieldSessionEntityType`

Source

public string Source { get; set; }

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][google.cloud.dialogflow.v2beta1.QueryResult.webhook_source] sent to the integration or API caller.

Property Value
Type	Description
`string`