public sealed class WebhookRequest : IMessage<WebhookRequest>, IEquatable<WebhookRequest>, IDeepCloneable<WebhookRequest>, IBufferMessage, IMessageReference documentation and code samples for the Dialogflow v3 API class WebhookRequest.
The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases.
You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.
Implements
IMessageWebhookRequest, IEquatableWebhookRequest, IDeepCloneableWebhookRequest, IBufferMessage, IMessageNamespace
Google.Cloud.Dialogflow.Cx.V3Assembly
Google.Cloud.Dialogflow.Cx.V3.dll
Constructors
WebhookRequest()
public WebhookRequest()WebhookRequest(WebhookRequest)
public WebhookRequest(WebhookRequest other)| Parameter | |
|---|---|
| Name | Description |
other | WebhookRequest |
Properties
DetectIntentResponseId
public string DetectIntentResponseId { get; set; }Always present. The unique identifier of the [DetectIntentResponse][google.cloud.dialogflow.cx.v3.DetectIntentResponse] that will be returned to the API caller.
| Property Value | |
|---|---|
| Type | Description |
string | |
DtmfDigits
public string DtmfDigits { get; set; }If [DTMF][google.cloud.dialogflow.cx.v3.DtmfInput] was provided as input, this field will contain the DTMF digits.
| Property Value | |
|---|---|
| Type | Description |
string | |
FulfillmentInfo
public WebhookRequest.Types.FulfillmentInfo FulfillmentInfo { get; set; }Always present. Information about the fulfillment that triggered this webhook call.
| Property Value | |
|---|---|
| Type | Description |
WebhookRequestTypesFulfillmentInfo | |
HasDtmfDigits
public bool HasDtmfDigits { get; }Gets whether the "dtmf_digits" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasText
public bool HasText { get; }Gets whether the "text" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasTranscript
public bool HasTranscript { get; }Gets whether the "transcript" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasTriggerEvent
public bool HasTriggerEvent { get; }Gets whether the "trigger_event" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
HasTriggerIntent
public bool HasTriggerIntent { get; }Gets whether the "trigger_intent" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
IntentInfo
public WebhookRequest.Types.IntentInfo IntentInfo { get; set; }Information about the last matched intent.
| Property Value | |
|---|---|
| Type | Description |
WebhookRequestTypesIntentInfo | |
LanguageCode
public string LanguageCode { get; set; }The language code specified in the [original request][QueryInput.language_code].
| Property Value | |
|---|---|
| Type | Description |
string | |
Messages
public RepeatedField<ResponseMessage> Messages { get; }The list of rich message responses to present to the user. Webhook can choose to append or replace this list in [WebhookResponse.fulfillment_response][google.cloud.dialogflow.cx.v3.WebhookResponse.fulfillment_response];
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldResponseMessage | |
PageInfo
public PageInfo PageInfo { get; set; }Information about page status.
| Property Value | |
|---|---|
| Type | Description |
PageInfo | |
Payload
public Struct Payload { get; set; }Custom data set in [QueryParameters.payload][google.cloud.dialogflow.cx.v3.QueryParameters.payload].
| Property Value | |
|---|---|
| Type | Description |
Struct | |
QueryCase
public WebhookRequest.QueryOneofCase QueryCase { get; }| Property Value | |
|---|---|
| Type | Description |
WebhookRequestQueryOneofCase | |
SentimentAnalysisResult
public WebhookRequest.Types.SentimentAnalysisResult SentimentAnalysisResult { get; set; }The sentiment analysis result of the current user request. The field is filled when sentiment analysis is configured to be enabled for the request.
| Property Value | |
|---|---|
| Type | Description |
WebhookRequestTypesSentimentAnalysisResult | |
SessionInfo
public SessionInfo SessionInfo { get; set; }Information about session status.
| Property Value | |
|---|---|
| Type | Description |
SessionInfo | |
Text
public string Text { get; set; }If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was provided as input, this field will contain a copy of the text.
| Property Value | |
|---|---|
| Type | Description |
string | |
Transcript
public string Transcript { get; set; }If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio.
| Property Value | |
|---|---|
| Type | Description |
string | |
TriggerEvent
public string TriggerEvent { get; set; }If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as input, this field will contain the name of the event.
| Property Value | |
|---|---|
| Type | Description |
string | |
TriggerIntent
public string TriggerIntent { get; set; }If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as
input, this field will contain a copy of the intent identifier. Format:
projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/intents/<Intent ID>.
| Property Value | |
|---|---|
| Type | Description |
string | |
TriggerIntentAsIntentName
public IntentName TriggerIntentAsIntentName { get; set; }IntentName-typed view over the TriggerIntent resource name property.
| Property Value | |
|---|---|
| Type | Description |
IntentName | |