CxFlowKnowledgeConnectorSettingsTriggerFulfillmentMessageArgs

data class CxFlowKnowledgeConnectorSettingsTriggerFulfillmentMessageArgs(val channel: Output<String>? = null, val conversationSuccess: Output<CxFlowKnowledgeConnectorSettingsTriggerFulfillmentMessageConversationSuccessArgs>? = null, val endInteractions: Output<List<CxFlowKnowledgeConnectorSettingsTriggerFulfillmentMessageEndInteractionArgs>>? = null, val knowledgeInfoCard: Output<CxFlowKnowledgeConnectorSettingsTriggerFulfillmentMessageKnowledgeInfoCardArgs>? = null, val liveAgentHandoff: Output<CxFlowKnowledgeConnectorSettingsTriggerFulfillmentMessageLiveAgentHandoffArgs>? = null, val mixedAudios: Output<List<CxFlowKnowledgeConnectorSettingsTriggerFulfillmentMessageMixedAudioArgs>>? = null, val outputAudioText: Output<CxFlowKnowledgeConnectorSettingsTriggerFulfillmentMessageOutputAudioTextArgs>? = null, val payload: Output<String>? = null, val playAudio: Output<CxFlowKnowledgeConnectorSettingsTriggerFulfillmentMessagePlayAudioArgs>? = null, val telephonyTransferCall: Output<CxFlowKnowledgeConnectorSettingsTriggerFulfillmentMessageTelephonyTransferCallArgs>? = null, val text: Output<CxFlowKnowledgeConnectorSettingsTriggerFulfillmentMessageTextArgs>? = null) : ConvertibleToJava<CxFlowKnowledgeConnectorSettingsTriggerFulfillmentMessageArgs>

Constructors

Properties

Link copied to clipboard
val channel: Output<String>? = null

The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.

Link copied to clipboard

Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example:

Link copied to clipboard

(Output) This type has no fields. Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user. This field is part of a union field message: Only one of text, payload, conversationSuccess, outputAudioText, liveAgentHandoff, endInteraction, playAudio, mixedAudio, telephonyTransferCall, or knowledgeInfoCard may be set.

Link copied to clipboard

This type has no fields. Represents info card response. If the response contains generative knowledge prediction, Dialogflow will return a payload with Infobot Messenger compatible info card. Otherwise, the info card response is skipped. This field is part of a union field message: Only one of text, payload, conversationSuccess, outputAudioText, liveAgentHandoff, endInteraction, playAudio, mixedAudio, telephonyTransferCall, or knowledgeInfoCard may be set.

Link copied to clipboard

Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example:

Link copied to clipboard

(Output) Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via playAudio. This message is generated by Dialogflow only and not supposed to be defined by the user. This field is part of a union field message: Only one of text, payload, conversationSuccess, outputAudioText, liveAgentHandoff, endInteraction, playAudio, mixedAudio, telephonyTransferCall, or knowledgeInfoCard may be set. Structure is documented below.

Link copied to clipboard

A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message. This field is part of a union field message: Only one of text, payload, conversationSuccess, outputAudioText, liveAgentHandoff, endInteraction, playAudio, mixedAudio, telephonyTransferCall, or knowledgeInfoCard may be set. Structure is documented below.

Link copied to clipboard
val payload: Output<String>? = null

Returns a response containing a custom, platform-specific payload. This field is part of a union field message: Only one of text, payload, conversationSuccess, outputAudioText, liveAgentHandoff, endInteraction, playAudio, mixedAudio, telephonyTransferCall, or knowledgeInfoCard may be set.

Link copied to clipboard

Specifies an audio clip to be played by the client as part of the response. This field is part of a union field message: Only one of text, payload, conversationSuccess, outputAudioText, liveAgentHandoff, endInteraction, playAudio, mixedAudio, telephonyTransferCall, or knowledgeInfoCard may be set. Structure is documented below.

Link copied to clipboard

Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. This field is part of a union field message: Only one of text, payload, conversationSuccess, outputAudioText, liveAgentHandoff, endInteraction, playAudio, mixedAudio, telephonyTransferCall, or knowledgeInfoCard may be set. Structure is documented below.

Link copied to clipboard

The text response message. This field is part of a union field message: Only one of text, payload, conversationSuccess, outputAudioText, liveAgentHandoff, endInteraction, playAudio, mixedAudio, telephonyTransferCall, or knowledgeInfoCard may be set. Structure is documented below.

Functions

Link copied to clipboard
open override fun toJava(): CxFlowKnowledgeConnectorSettingsTriggerFulfillmentMessageArgs