Collect keypad input

Play one prompt and collect a caller's keypad input.
View as Markdown

Use Play prompt and collect DTMF digits for one prompt-and-collect cycle. DTMF is the signalling system produced by telephone keypad presses. Configure the allowed digit count, timeouts, and optional terminator; then inspect the resulting digits.collected event to decide what your application should do next.

Every key press also emits an individual dtmf.received event as it happens, including while play_and_get_digits is collecting input. Use these events for per-key handling and digits.collected for the final aggregated result.

The command returns 202 Accepted when queued. Include an operation_uuid so the final event can be correlated with the request. If the caller must re-enter input, issue another collection command; the service does not retry a collection automatically.

Use Cancel an in-progress play_and_get_digits to end the current cycle early.