Cancel in-progress DTMF collection

View as Markdown
**Rate limit: Per command** · **Burst:** 4 · **Refill:** 0.8 req/s Cancel the current DTMF collection for this session. If no collection is in progress, the request is accepted and has no effect. If a collection is in progress, cancellation proceeds in these stages: 1. The `202` response accepts the cancellation request. 2. Prompt playback stops promptly. 3. The collection phase ends according to its existing timers. 4. The platform emits the terminal `digits.collected` webhook with `status: cancelled`. The `202` response does not mean that the terminal webhook is ready. Input entered after cancellation is discarded from later collections. It is reported only by the cancelled command's terminal `digits.collected` event. This DELETE uses its own rate-limit bucket. The corresponding POST uses the same configuration in a separate bucket. See [Keypad input lifecycle events](/api/keypad-input#lifecycle-events) for complete payload schemas and examples.

Authentication

AuthorizationBearer
Application auth. Send `Authorization: Bearer <app_uuid>:<api_key>` using any active key in the app's collection. See [Authentication](https://voice-platform.docs.buildwithfern.com/api/authentication) for details.

Path parameters

uuidstringRequired

Session identifier.

Headers

Operation-IdstringOptionalformat: "uuid"

optional client-supplied lowercase RFC-4122 v4 UUID returned as operation_uuid; platform generates one when omitted; correlation metadata distinct from Idempotency-Key.

Response

Cancellation accepted.
operation_uuidstringformat: "uuid"
statusenum

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error