<prompt>

Controls the output of text-to-speech (TTS) and audio sources.

Syntax

<prompt
    bargein = "{true | false}"
    bargeintype = "{speech | hotword}"
    cond = "CDATA"
    count = "integer"
    timeout = "integer"
    version = "CDATA"
    xml:base = "CDATA"
    xml:lang = "CDATA"
/>

Attributes

None of the <prompt> attributes are required.

Attribute

Data Type

Required?

Default

Description

bargein

boolean

no

yes

Indicates whether a user can interrupt the prompt. This attribute overrides a bargein previously set with the <property> element.

bargeintype

{speech | hotword}

no

speech

Type of bargein that can interrupt this prompt. This attribute overrides a bargein type previously set with the <property> element.

cond

CDATA

no

NA

Boolean expression that must evaluate to ECMAScript true for the prompt to be played.

count

integer

no

1

A number that allows you to emit different prompts if the user does something repeatedly.

timeout

integer

no

NA

Silence time, in seconds, after which a noinput event is raised. This attribute overrides a timeout set previously by the <property> element.

version

CDATA

no

NA

Currently not supported.

xml:base

CDATA

no

NA

Currently not supported.

xml:lang

CDATA

no

NA

RFC 1766 compliant identifier used to locate the text-to-speech (TTS) engine used to render text prompts.

Details

SSML elements provide a hint as to how the enclosed text should be spoken. Whether or not a certain element has an effect depends on the capabilities of the TTS engine currently in use. In some cases, only certain attributes of an element have an effect, and even then, the level of control may not be as high as is described in the specification.

For a list of elements and attributes supported by the current set of TTS engines, see SSML Support.

Parents

<block>, <catch>, <error>, <help>, <field>, <filled>, <foreach>, <help>, <if>, <menu>, <initial>, <noinput>, <nomatch>, <object>, <record>, <subdialog>, <transfer>

Children

<audio>, <break>, <emphasis>, <enumerate>, <lexicon>, <mark>, <meta>, <metadata>, <p>, <foreach>, <par>, <phoneme>, <prosody>, <s>, <say-as>, <sub>, <value>, <voice>

Example

<?xml version="1.0"?>
<vxml version="2.1" xmlns="http://www.w3.org/2001/vxml">
    <form id="french">
    <block>
            <prompt xml:lang="fr-FR">
                bonjour, bienvenue au service vocal.
            </prompt>
            <goto next="#english"/>
        </block>
    </form>
    <form id="english">
        <block>
            <prompt xml:lang="en-GB">
                hello, welcome to the voice portal.
            </prompt>
            <goto next="#spanish"/>
        </block>
    </form>
    <form id="spanish">
        <block>
            <prompt xml:lang="es-ES">
                buenos días, bienvenida sobre el servicio vocal.
            </prompt>
        </block>
    </form>
</vxml>

See Also

<audio>, <par>