Package version:

Interface CallMediaRecognizeDtmfOptions

The recognize configuration specific to Dtmf.

interface CallMediaRecognizeDtmfOptions {
    initialSilenceTimeoutInSeconds?: number;
    interruptCallMediaOperation?: boolean;
    interruptPrompt?: boolean;
    interToneTimeoutInSeconds?: number;
    kind: "callMediaRecognizeDtmfOptions";
    maxTonesToCollect?: number;
    operationCallbackUrl?: string;
    operationContext?: string;
    playPrompt?: FileSource | TextSource | SsmlSource;
    playPrompts?: (FileSource | TextSource | SsmlSource)[];
    stopCurrentOperations?: boolean;
    stopDtmfTones?: DtmfTone[];
}

Hierarchy (view full)

Properties

initialSilenceTimeoutInSeconds? interruptCallMediaOperation? interruptPrompt? interToneTimeoutInSeconds? kind maxTonesToCollect? operationCallbackUrl? operationContext? playPrompt? playPrompts? stopCurrentOperations? stopDtmfTones?

Properties

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.

OptionalinterToneTimeoutInSeconds

interToneTimeoutInSeconds?: number

Time to wait between DTMF inputs to stop recognizing.

Readonlykind

kind

OptionalmaxTonesToCollect

maxTonesToCollect?: number

Maximum number of DTMF tones to be collected.

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.

OptionalstopCurrentOperations

stopCurrentOperations?: boolean

Deprecated

Not in use, instead use interruptCallMediaOperation for similar functionality

OptionalstopDtmfTones

stopDtmfTones?: DtmfTone[]

List of tones that will stop recognizing.

Settings

Member Visibility