Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class ResponseMessage.
Response messages from an automated agent.
Generated from protobuf message google.cloud.dialogflow.v2.ResponseMessage
Namespace
Google \ Cloud \ Dialogflow \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ text |
ResponseMessage\Text
Returns a text response. |
↳ payload |
Google\Protobuf\Struct
Returns a response containing a custom, platform-specific payload. |
↳ live_agent_handoff |
ResponseMessage\LiveAgentHandoff
Hands off conversation to a live agent. |
↳ end_interaction |
ResponseMessage\EndInteraction
A signal that indicates the interaction with the Dialogflow agent has ended. |
↳ mixed_audio |
ResponseMessage\MixedAudio
An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. |
↳ telephony_transfer_call |
ResponseMessage\TelephonyTransferCall
A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. |
getText
Returns a text response.
| Returns | |
|---|---|
| Type | Description |
ResponseMessage\Text|null |
|
hasText
setText
Returns a text response.
| Parameter | |
|---|---|
| Name | Description |
var |
ResponseMessage\Text
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPayload
Returns a response containing a custom, platform-specific payload.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null |
|
hasPayload
setPayload
Returns a response containing a custom, platform-specific payload.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLiveAgentHandoff
Hands off conversation to a live agent.
| Returns | |
|---|---|
| Type | Description |
ResponseMessage\LiveAgentHandoff|null |
|
hasLiveAgentHandoff
setLiveAgentHandoff
Hands off conversation to a live agent.
| Parameter | |
|---|---|
| Name | Description |
var |
ResponseMessage\LiveAgentHandoff
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndInteraction
A signal that indicates the interaction with the Dialogflow agent has ended.
| Returns | |
|---|---|
| Type | Description |
ResponseMessage\EndInteraction|null |
|
hasEndInteraction
setEndInteraction
A signal that indicates the interaction with the Dialogflow agent has ended.
| Parameter | |
|---|---|
| Name | Description |
var |
ResponseMessage\EndInteraction
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMixedAudio
An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client.
| Returns | |
|---|---|
| Type | Description |
ResponseMessage\MixedAudio|null |
|
hasMixedAudio
setMixedAudio
An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client.
| Parameter | |
|---|---|
| Name | Description |
var |
ResponseMessage\MixedAudio
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTelephonyTransferCall
A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
| Returns | |
|---|---|
| Type | Description |
ResponseMessage\TelephonyTransferCall|null |
|
hasTelephonyTransferCall
setTelephonyTransferCall
A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
| Parameter | |
|---|---|
| Name | Description |
var |
ResponseMessage\TelephonyTransferCall
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMessage
| Returns | |
|---|---|
| Type | Description |
string |
|