ConnectParticipantWithLexBot

Connects the participant with the specified Amazon Lex bot. When the interaction is over, the Intent and Slots of the bot are available to the flow during its run.

Parameter object

Provide either LexBot or LexV2Bot object depending on the Amazon Lex version in the following format.

LexV2

{
    "PromptId": [Optional] A prompt ID or prompt ARN to play to the participant along with gathering input. May not be specified if Text or SSML is also specified. Must be specified either statically or as a single valid JSONPath identifier.
    "Text":  An optional string that defines text to send to the participant along with gathering input. May not be specified if PromptId or SSML is also specified. May be specified statically or dynamically.
    "SSML": An optional string that defines SSML to send to the participant along with gathering input. May not be specified if Text or PromptId is also specified May be specified statically or dynamically.
    "Media": { An optional object that defines an external media source.
        "Uri": Location of the message.
        "SourceType": The source from which the message will be fetched. The only supported type is S3.
        "MediaType": The type of the message to be played. The only supported type is Audio.
    }
    "LexV2Bot": { The details of the LexV2 bot to invoke.       
        "AliasArn": The alias ARN of the LexV2 bot to invoke. May be specified statically or dynamically.
    },
    "LexSessionAttributes": { A map of session attributes to pass to the Amazon LexV2 bot when it is invoked. The keys and values may be static or dynamic.
    },
   "LexTimeoutSeconds": { [Optional] A mapping that defines the length of Lex timer in second, which will timeout inactive customers in a Lex interaction.
        "Text": An optional string that defines the Lex timer length for chat.
   }       
}        

Lex classic

{
    "PromptId": [Optional] A prompt ID or prompt ARN to play to the participant along with gathering input. May not be specified if Text or SSML is also specified. Must be specified either statically or as a single valid JSONPath identifier.
    "Text":  An optional string that defines text to send to the participant along with gathering input. May not be specified if PromptId or SSML is also specified. May be specified statically or dynamically.
    "SSML": An optional string that defines SSML to send to the participant along with gathering input. May not be specified if Text or PromptId is also specified May be specified statically or dynamically.
    "Media": { An optional object that defines an external media source.
        "Uri": Location of the message.
        "SourceType": The source from which the message will be fetched. The only supported type is S3.
        "MediaType": The type of the message to be played. The only supported type is Audio.
    }
    "LexBot": { The details of the Lex bot to invoke.
        "Name": The name of the Lex bot. May be specified statically or dynamically.
        "Region": The region in which this Lex bot exists. May be specified statically or dynamically.
        "Alias": The specific alias of the Lex bot to invoke. May be specified statically or dynamically.
    },
    "LexSessionAttributes": { A map of session attributes to pass to the Amazon Lex bot when it is invoked. The keys and values may be static or dynamic.
    },
   "LexTimeoutSeconds": { [Optional] A mapping that defines the length of Lex timer in second, which will timeout inactive customers in a Lex interaction.
        "Text": An optional string that defines the Lex timer length for chat.
   }
}    

Results and conditions

If the Amazon Lex interaction succeeds, the result is the Intent of the bot. Conditions are supported, but only the Equals operator is supported within these conditions.

Errors

• NoMatchingCondition - If no specified condition evaluated to True.

• NoMatchingError - If an error occurred and no other error matched.

• InputTimeLimitExceeded - if there is no response before the configured LexTimeoutSeconds.

Restrictions

This action is supported by all channels.

This action is available only in contact flows, transfer flows, and customer queue flows. It is not available in whisper flows or hold flows.

Corresponding block in the UI

Get customer input