GetDigits

GetDigitsAction collects DTMF from the caller, optionally with a nested `<Say>` / `<Play>` prompt. Mirrors the PBX `<GetDigits>` verb.

2026-06-27

GetDigitsAction collects DTMF from the caller, optionally with a nested <Say> / <Play> prompt. Mirrors the PBX <GetDigits> verb.

Parameter	Type	JSON key	Required	Description
`Timeout`	`int`	`timeout`	No	Timeout is the number of seconds to wait for input after the prompt finishes. Defaults to PBX default.
`NumDigits`	`int`	`numDigits`	No	NumDigits limits input to exactly this many digits. 0 means unlimited.
`FinishOnKey`	`string`	`finishOnKey`	No	FinishOnKey is the DTMF key that submits input early. Defaults to "#".
`Nested`	`[]VoiceAction`	`nested`	No	Nested verbs played while waiting for input (Say, Play).

import { sauti, say } from "@sautikit/node";

res.json(
sauti.getDigits({ numDigits: 1, timeout: 5, finishOnKey: "#" }, [
  say("Press 1 to confirm, 2 to cancel."),
]),
);

{
"actions": [
  {
    "getDigits": {
      "numDigits": 1,
      "timeout": 5,
      "finishOnKey": "#",
      "nested": [
        {
          "say": {
            "text": "Press 1 to confirm, 2 to cancel."
          }
        }
      ]
    }
  }
]
}

<GetDigits numDigits="1" timeout="5" finishOnKey="#"><Say>Press 1 to confirm, 2 to cancel.</Say></GetDigits>