Skip to main content

Interface: NormalizedDtmfReceived

Defined in: packages/agentos/src/io/channels/telephony/types.ts:378

DTMF (Dual-Tone Multi-Frequency) digit received during a call.

DTMF events do NOT trigger a call state transition -- the call remains in its current state (typically listening or active). They are relayed as informational events so higher-level logic (e.g., IVR menus, PIN entry) can react to caller key-presses.

Delivery paths​

All three carriers have webhook and media-stream DTMF paths. A webhook occurrence identity and a media-stream sequence belong to their own delivery channels; hosts choose one input path for an IVR action.

Example​

if (event.kind === 'call-dtmf') {
console.log(`User pressed ${event.digit} for ${event.durationMs}ms`);
}

Extends​

  • NormalizedEventBase

Properties​

digit​

digit: string

Defined in: packages/agentos/src/io/channels/telephony/types.ts:386

The digit pressed by the caller.

Standard DTMF digits: '0'-'9', '*', '#'. Extended DTMF (rarely supported): 'A'-'D'.


durationMs?​

optional durationMs: number

Defined in: packages/agentos/src/io/channels/telephony/types.ts:394

How long the key was pressed in milliseconds, when the message carries it.

Most messages omit it: Twilio's documented media-stream dtmf message carries only the track and the digit, and Telnyx and Plivo webhook payloads typically omit it.


eventId​

eventId: string

Defined in: packages/agentos/src/io/channels/telephony/types.ts:275

Provider-assigned event ID for idempotency.

Inherited from​

NormalizedEventBase.eventId


kind​

kind: "call-dtmf"

Defined in: packages/agentos/src/io/channels/telephony/types.ts:379


provider?​

optional provider: VoiceProviderName

Defined in: packages/agentos/src/io/channels/telephony/types.ts:281

Provider namespace attached by stable carrier parsing.

Inherited from​

NormalizedEventBase.provider


providerCallId​

providerCallId: string

Defined in: packages/agentos/src/io/channels/telephony/types.ts:277

Provider-assigned call ID.

Inherited from​

NormalizedEventBase.providerCallId


providerRequestId?​

optional providerRequestId: string

Defined in: packages/agentos/src/io/channels/telephony/types.ts:283

Creation request identity when distinct from the actual call leg.

Inherited from​

NormalizedEventBase.providerRequestId


timestamp​

timestamp: number

Defined in: packages/agentos/src/io/channels/telephony/types.ts:279

Unix timestamp (ms).

Inherited from​

NormalizedEventBase.timestamp