DtmfInput

The DTMF (Dual-Tone Multi-Frequency) input from the client.

Represents touch-tone keypad input from telephony or client applications.

  1. Collection & Buffering: Clients may stream single digits in real time as the user presses them, or send multiple digits at once. Food AI Agent buffers incoming digits and resets caller inactivity timers.
  2. Endpointing & Termination: The sequence is finalized when an agent-configured finish digit (default is '#') is encountered, or when an endpointing silence timeout (default is 3 seconds) elapses without new digits. If a finish digit terminates a sequence, it is stripped from the digits passed to the agent unless it was the sole digit entered.
  3. Agent Response: Once finalized, Food AI Agent processes the digits and responds with standard conversational turn output (such as synthesized agent audio, POS tool calls, or text).
  4. Dynamic Control: The agent can dynamically enable or disable DTMF listening, configure the finish digit, or adjust the endpointing timeout per turn based on conversational context (for example, when prompting for a zip code or card number).
JSON representation 
{
  "digits": string,
  "finishDigit": string
}
Fields
digits

string

Required. The DTMF digits entered by the user.

Supported DTMF characters: '0'-'9', '*', '#', and 'A'-'D'.
finishDigit

string

Optional. The finish digit (e.g., '#') that was used to complete the DTMF input, if any. When streaming digits in real time, clients can either send the finish digit as the last character in digits or specify it explicitly here.