CallMediaRecognizeDtmfOptions interface

Package:

@azure/communication-call-automation

The recognize configuration specific to Dtmf.

Extends

CallMediaRecognizeOptions

Properties

interToneTimeoutInSeconds	Time to wait between DTMF inputs to stop recognizing.
kind
maxTonesToCollect	Maximum number of DTMF tones to be collected.
stopDtmfTones	List of tones that will stop recognizing.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
initialSilenceTimeoutInSeconds	Time to wait for first input after prompt.
interruptCallMediaOperation	If set recognize can barge into other existing queued-up/currently-processing requests.
interruptPrompt	Determines if we interrupt the prompt and start recognizing.
onResponse	A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
operationCallbackUrl	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.
operationContext	The value to identify context of the operation.
playPrompt	The source of the audio to be played for recognition.
playPrompts	The list source of the audio to be played for recognition.
requestOptions	Options used when creating and sending HTTP requests for this operation.
serializerOptions	Options to override serialization/de-serialization behavior.
stopCurrentOperations
tracingOptions	Options used when tracing is enabled.

Property Details

interToneTimeoutInSeconds

Time to wait between DTMF inputs to stop recognizing.

interToneTimeoutInSeconds?: number

Property Value

number

kind

kind: "callMediaRecognizeDtmfOptions"

Property Value

"callMediaRecognizeDtmfOptions"

maxTonesToCollect

Maximum number of DTMF tones to be collected.

maxTonesToCollect?: number

Property Value

number

stopDtmfTones

List of tones that will stop recognizing.

stopDtmfTones?: DtmfTone[]

Property Value

DtmfTone[]

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From CallMediaRecognizeOptions.abortSignal

initialSilenceTimeoutInSeconds

Time to wait for first input after prompt.

initialSilenceTimeoutInSeconds?: number

Property Value

number

Inherited From CallMediaRecognizeOptions.initialSilenceTimeoutInSeconds

interruptCallMediaOperation

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

interruptCallMediaOperation?: boolean

Property Value

boolean

Inherited From CallMediaRecognizeOptions.interruptCallMediaOperation

interruptPrompt

Determines if we interrupt the prompt and start recognizing.

interruptPrompt?: boolean

Property Value

boolean

Inherited From CallMediaRecognizeOptions.interruptPrompt

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From CallMediaRecognizeOptions.onResponse

operationCallbackUrl

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.

operationCallbackUrl?: string

Property Value

string

Inherited From CallMediaRecognizeOptions.operationCallbackUrl

operationContext

The value to identify context of the operation.

operationContext?: string

Property Value

string

Inherited From CallMediaRecognizeOptions.operationContext

playPrompt

The source of the audio to be played for recognition.

playPrompt?: FileSource | TextSource | SsmlSource

Property Value

FileSource | TextSource | SsmlSource

Inherited From CallMediaRecognizeOptions.playPrompt

playPrompts

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

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

Property Value

(FileSource | TextSource | SsmlSource)[]

Inherited From CallMediaRecognizeOptions.playPrompts

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From CallMediaRecognizeOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From CallMediaRecognizeOptions.serializerOptions

stopCurrentOperations

Warning

This API is now deprecated.

Not in use, instead use interruptCallMediaOperation for similar functionality

stopCurrentOperations?: boolean

Property Value

boolean

Inherited From CallMediaRecognizeOptions.stopCurrentOperations

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CallMediaRecognizeOptions.tracingOptions