PlaybackInterruptionEvent - Amazon Lex

PlaybackInterruptionEvent

Event sent from Amazon Lex V2 to indicate to the client application should stop playback of audio. For example, if the client is playing a prompt that asks for the user's telephone number, the user might start to say the phone number before the prompt is complete. Amazon Lex V2 sends this event to the client application to indicate that the user is responding and that Amazon Lex V2 is processing their input.

Contents

causedByEventId

The identifier of the event that contained the audio, DTMF, or text that caused the interruption.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 100.

Pattern: [0-9a-zA-Z._:-]+

Required: No

eventId

A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form RESPONSE-N, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 100.

Pattern: [0-9a-zA-Z._:-]+

Required: No

eventReason

Indicates the type of user input that Amazon Lex V2 detected.

Type: String

Valid Values: DTMF_START_DETECTED | TEXT_DETECTED | VOICE_START_DETECTED

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: