Cancel in-progress DTMF collection
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:
- The
202response accepts the cancellation request. - Prompt playback stops promptly.
- The collection phase ends according to its existing timers.
- The platform emits the terminal
digits.collectedwebhook withstatus: 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 for complete payload schemas and examples.
Authentication
Send Authorization: Bearer <app_uuid>:<api_key> using an active API key. See Authentication for details.
Path parameters
Session identifier.
Headers
Optional key for safely retrying mutating requests. An explicitly empty header is treated like omission and does not enable replay protection. See Idempotency for details.
optional client-supplied lowercase RFC-4122 v4 UUID returned as operation_uuid; platform generates one when omitted; correlation metadata distinct from Idempotency-Key.
Response headers
Server-owned W3C Trace Context for correlating this response with support and observability data. It is present on successful and error responses. A valid incoming traceparent is linked to, but never becomes, the server-owned trace identifier.