Documentation

Prompt Methods

A prompt method speaks out a message and then waits for digits to be pressed.

There are also multi-try prompts which is the same as a regular prompt, only it will repeat over and over until its either exhausted the attempts or the response is accepted. It gives people on the other end of the call a few attempts to enter data before giving up.

On this page

Prompt

This is the simplest of the options. It speaks out a wav file and then waits for input. There is a 5 second timeout. The user can enter up to 30 digits including the terminator key which is the # key. Each time a digit is pressed, the 5 second timer starts over again.

Parameter 1 excpects a wav file name or a phrase (aka a sentence). A sentence is expected if the parameter has a | in it. In that case the string needs to be in the "code|characters,..." format.

// play a wav file and wait for digits to be pressed
var result = await line.PromptAsync($"{WAV_FILE_LOCATION}/Press1234.wav", cancellationToken);

Prompt with a phrase

Here is an example of speaking out a phrase.

// Speak out "A B C" and wait for digits to be pressed
var result = await line.PromptAsync($"C|abc", cancellationToken);

Prompt with overrides

An example of overriding some of the prompt options.

// play a wav file and wait for digits to be pressed
var result = await line.PromptAsync($"{WAV_FILE_LOCATION}/Press1234.wav", cancellationToken,
new PromptOptions
{
    Terminators = "#",
    MaxLength = 30
});

Single digit prompt

A single digit prompt. For example "For option A press 1, for option B press 2."

// play a wav file and wait for digits to be pressed
var result = await line.PromptAsync($"{WAV_FILE_LOCATION}/Press1234.wav", cancellationToken,
new PromptOptions { MaxLength = 1 });

Multi-try prompts

Multi-try prompts are just like regular prompts only the give the user multiple tries to enter data correctly.

There is is more setup to do. You will need the following set up:

Something	Description
Evaulator	This is a method that you pass in to validate what the user entered. Return true if it is valid.
InvalidAnswerMessage	(Optional) A message to speak if the evaluator returns false. You cloud also leave this empty and speak what you want in the evaluator method.

Here are the defaults:

99 attempts - prompt can have 99 fails.
5 attempts - only 5 fails in a row can happen when blank
Will throw TooManyAttempts if the max attempts are hit.

// option 1 - let the evaluator speak the invalid message
var result = await line.MultiTryPromptAsync($"{WAV_FILE_LOCATION}/Press1234.wav",
    (answer) =>
    {
        if (answer == "1234") return true;
        await line.PlayFileAsync("invalidAnswer.wav", cancellationToken);
        return false;
    },
    cancellationToken);

// option 2 - override the multi-try options to set up the invalid message.
var result = await line.MultiTryPromptAsync($"{WAV_FILE_LOCATION}/Press1234.wav",
(answer) => answer == "1234",
new MultiTryPromptOptions{ InvalidAnswerMessage = "invalidAnswer.wav"}, cancellationToken);