DtmfMessageEvent Class

  • Article

DtmfMessageEvent Class

Raised by:  TIM
Base Class:  TIMEvent
Derived Classes:  None

DtmfMessageEvent is raised by the telephony interface manager (TIM) software to log receipt of DTMF messages.

DtmfMessageEvent has the following properties:

Property

Type

Description

Playback

Boolean

False if the DTMF input was generated by the user, otherwise true.
A value of true indicates the DTMF was passed between telephones, for example by an application, without user input.

DtmfText

String

A string containing the actual DTMF input (populated only when the value of the Playback property is true).

GrammarUrls

StringArray

An array of grammar URLs that were used in this DTMF recognition. This property is populated at the start and completion of the recognition. Only grammars currently loaded are included in the array.

Remarks

For security reasons, DTMF keys received from the user should never be included in the logged information. For this reason, the DtmfText property is populated only when the value of the Playback property is true.

See Also

Event Logging Class Hierarchy | Logging and Analyzing Events | CommonEvent | Event Filters | Filtering Logged Events