Package version:

Interface CallMediaRecognizeChoiceOptions

The recognize configuration specific to Choices.

interface CallMediaRecognizeChoiceOptions {
    choices: RecognitionChoice[];
    initialSilenceTimeoutInSeconds?: number;
    interruptCallMediaOperation?: boolean;
    interruptPrompt?: boolean;
    kind: "callMediaRecognizeChoiceOptions";
    operationCallbackUrl?: string;
    operationContext?: string;
    playPrompt?: FileSource | TextSource | SsmlSource;
    playPrompts?: (FileSource | TextSource | SsmlSource)[];
    speechLanguage?: string;
    speechRecognitionModelEndpointId?: string;
    stopCurrentOperations?: boolean;
}

Hierarchy (view full)

Properties

choices initialSilenceTimeoutInSeconds? interruptCallMediaOperation? interruptPrompt? kind operationCallbackUrl? operationContext? playPrompt? playPrompts? speechLanguage? speechRecognitionModelEndpointId? stopCurrentOperations?

Properties

choices

choices: RecognitionChoice[]

The IvR choices for recognize.

OptionalinitialSilenceTimeoutInSeconds

initialSilenceTimeoutInSeconds?: number

Time to wait for first input after prompt.

OptionalinterruptCallMediaOperation

interruptCallMediaOperation?: boolean

If set recognize can barge into other existing queued-up/currently-processing requests.

OptionalinterruptPrompt

interruptPrompt?: boolean

Determines if we interrupt the prompt and start recognizing.

Readonlykind

kind

OptionaloperationCallbackUrl

operationCallbackUrl?: string

Set a callback URL that overrides the default callback URL set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.

OptionaloperationContext

operationContext?: string

The value to identify context of the operation.

OptionalplayPrompt

playPrompt?: FileSource | TextSource | SsmlSource

The source of the audio to be played for recognition.

OptionalplayPrompts

playPrompts?: (FileSource | TextSource | SsmlSource)[]

The list source of the audio to be played for recognition.

OptionalspeechLanguage

speechLanguage?: string

Speech language to be recognized, If not set default is en-US

OptionalspeechRecognitionModelEndpointId

speechRecognitionModelEndpointId?: string

Endpoint where the custom model was deployed.

OptionalstopCurrentOperations

stopCurrentOperations?: boolean

Deprecated

Not in use, instead use interruptCallMediaOperation for similar functionality

Settings

Member Visibility