Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client 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.
Generated from protobuf messagegoogle.cloud.dialogflow.cx.v3.WebhookRequest
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ detect_intent_response_id
string
Always present. The unique identifier of theDetectIntentResponsethat will be returned to the API caller.
↳ text
string
Ifnatural language textwas provided as input, this field will contain a copy of the text.
↳ trigger_intent
string
If anintentwas provided as input, this field will contain a copy of the intent identifier. Format:projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>.
Always present. The unique identifier of theDetectIntentResponsethat will be returned to the API caller.
Returns
Type
Description
string
setDetectIntentResponseId
Always present. The unique identifier of theDetectIntentResponsethat will be returned to the API caller.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getText
Ifnatural language textwas
provided as input, this field will contain a copy of the text.
Returns
Type
Description
string
hasText
setText
Ifnatural language textwas
provided as input, this field will contain a copy of the text.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getTriggerIntent
If anintentwas provided as
input, this field will contain a copy of the intent identifier. Format:projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>.
Returns
Type
Description
string
hasTriggerIntent
setTriggerIntent
If anintentwas provided as
input, this field will contain a copy of the intent identifier. Format:projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dialogflow Cx V3 Client - Class WebhookRequest (0.8.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.8.1 (latest)](/php/docs/reference/cloud-dialogflow-cx/latest/V3.WebhookRequest)\n- [0.8.0](/php/docs/reference/cloud-dialogflow-cx/0.8.0/V3.WebhookRequest)\n- [0.7.2](/php/docs/reference/cloud-dialogflow-cx/0.7.2/V3.WebhookRequest)\n- [0.6.0](/php/docs/reference/cloud-dialogflow-cx/0.6.0/V3.WebhookRequest)\n- [0.5.2](/php/docs/reference/cloud-dialogflow-cx/0.5.2/V3.WebhookRequest)\n- [0.4.1](/php/docs/reference/cloud-dialogflow-cx/0.4.1/V3.WebhookRequest)\n- [0.3.4](/php/docs/reference/cloud-dialogflow-cx/0.3.4/V3.WebhookRequest)\n- [0.2.1](/php/docs/reference/cloud-dialogflow-cx/0.2.1/V3.WebhookRequest)\n- [0.1.1](/php/docs/reference/cloud-dialogflow-cx/0.1.1/V3.WebhookRequest) \nReference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class WebhookRequest.\n\nThe request message for a webhook call. The request is sent as a JSON object\nand the field names will be presented in camel cases.\n\nYou may see undocumented fields in an actual request. These fields are used\ninternally by Dialogflow and should be ignored.\n\nGenerated from protobuf message `google.cloud.dialogflow.cx.v3.WebhookRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dialogflow \\\\ Cx \\\\ V3\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getDetectIntentResponseId\n\nAlways present. The unique identifier of the\n[DetectIntentResponse](/php/docs/reference/cloud-dialogflow-cx/latest/V3.DetectIntentResponse)\nthat will be returned to the API caller.\n\n### setDetectIntentResponseId\n\nAlways present. The unique identifier of the\n[DetectIntentResponse](/php/docs/reference/cloud-dialogflow-cx/latest/V3.DetectIntentResponse)\nthat will be returned to the API caller.\n\n### getText\n\nIf [natural language text](/php/docs/reference/cloud-dialogflow-cx/latest/V3.TextInput) was\nprovided as input, this field will contain a copy of the text.\n\n### hasText\n\n### setText\n\nIf [natural language text](/php/docs/reference/cloud-dialogflow-cx/latest/V3.TextInput) was\nprovided as input, this field will contain a copy of the text.\n\n### getTriggerIntent\n\nIf an [intent](/php/docs/reference/cloud-dialogflow-cx/latest/V3.IntentInput) was provided as\ninput, this field will contain a copy of the intent identifier. Format:\n`projects/\u003cProjectID\u003e/locations/\u003cLocationID\u003e/agents/\u003cAgentID\u003e/intents/\u003cIntentID\u003e`.\n\n### hasTriggerIntent\n\n### setTriggerIntent\n\nIf an [intent](/php/docs/reference/cloud-dialogflow-cx/latest/V3.IntentInput) was provided as\ninput, this field will contain a copy of the intent identifier. Format:\n`projects/\u003cProjectID\u003e/locations/\u003cLocationID\u003e/agents/\u003cAgentID\u003e/intents/\u003cIntentID\u003e`.\n\n### getTranscript\n\nIf [natural language speech\naudio](/php/docs/reference/cloud-dialogflow-cx/latest/V3.AudioInput) was provided as input,\nthis field will contain the transcript for the audio.\n\n### hasTranscript\n\n### setTranscript\n\nIf [natural language speech\naudio](/php/docs/reference/cloud-dialogflow-cx/latest/V3.AudioInput) was provided as input,\nthis field will contain the transcript for the audio.\n\n### getTriggerEvent\n\nIf an [event](/php/docs/reference/cloud-dialogflow-cx/latest/V3.EventInput) was provided as\ninput, this field will contain the name of the event.\n\n### hasTriggerEvent\n\n### setTriggerEvent\n\nIf an [event](/php/docs/reference/cloud-dialogflow-cx/latest/V3.EventInput) was provided as\ninput, this field will contain the name of the event.\n\n### getDtmfDigits\n\nIf [DTMF](/php/docs/reference/cloud-dialogflow-cx/latest/V3.DtmfInput) was provided as input,\nthis field will contain the DTMF digits.\n\n### hasDtmfDigits\n\n### setDtmfDigits\n\nIf [DTMF](/php/docs/reference/cloud-dialogflow-cx/latest/V3.DtmfInput) was provided as input,\nthis field will contain the DTMF digits.\n\n### getLanguageCode\n\nThe language code specified in the original request.\n\n### setLanguageCode\n\nThe language code specified in the original request.\n\n### getFulfillmentInfo\n\nAlways present. Information about the fulfillment that triggered this\nwebhook call.\n\n### hasFulfillmentInfo\n\n### clearFulfillmentInfo\n\n### setFulfillmentInfo\n\nAlways present. Information about the fulfillment that triggered this\nwebhook call.\n\n### getIntentInfo\n\nInformation about the last matched intent.\n\n### hasIntentInfo\n\n### clearIntentInfo\n\n### setIntentInfo\n\nInformation about the last matched intent.\n\n### getPageInfo\n\nInformation about page status.\n\n### hasPageInfo\n\n### clearPageInfo\n\n### setPageInfo\n\nInformation about page status.\n\n### getSessionInfo\n\nInformation about session status.\n\n### hasSessionInfo\n\n### clearSessionInfo\n\n### setSessionInfo\n\nInformation about session status.\n\n### getMessages\n\nThe list of rich message responses to present to the user. Webhook can\nchoose to append or replace this list in\n[WebhookResponse.fulfillment_response](/php/docs/reference/cloud-dialogflow-cx/latest/V3.WebhookResponse#_Google_Cloud_Dialogflow_Cx_V3_WebhookResponse__getFulfillmentResponse__);\n\n### setMessages\n\nThe list of rich message responses to present to the user. Webhook can\nchoose to append or replace this list in\n[WebhookResponse.fulfillment_response](/php/docs/reference/cloud-dialogflow-cx/latest/V3.WebhookResponse#_Google_Cloud_Dialogflow_Cx_V3_WebhookResponse__getFulfillmentResponse__);\n\n### getPayload\n\nCustom data set in\n[QueryParameters.payload](/php/docs/reference/cloud-dialogflow-cx/latest/V3.QueryParameters#_Google_Cloud_Dialogflow_Cx_V3_QueryParameters__getPayload__).\n\n### hasPayload\n\n### clearPayload\n\n### setPayload\n\nCustom data set in\n[QueryParameters.payload](/php/docs/reference/cloud-dialogflow-cx/latest/V3.QueryParameters#_Google_Cloud_Dialogflow_Cx_V3_QueryParameters__getPayload__).\n\n### getSentimentAnalysisResult\n\nThe sentiment analysis result of the current user request. The field is\nfilled when sentiment analysis is configured to be enabled for the request.\n\n### hasSentimentAnalysisResult\n\n### clearSentimentAnalysisResult\n\n### setSentimentAnalysisResult\n\nThe sentiment analysis result of the current user request. The field is\nfilled when sentiment analysis is configured to be enabled for the request.\n\n### getLanguageInfo\n\nInformation about the language of the request.\n\n### hasLanguageInfo\n\n### clearLanguageInfo\n\n### setLanguageInfo\n\nInformation about the language of the request.\n\n### getQuery"]]
