Cancel an in-progress play_and_get_digits

View as Markdown
**Rate limit: Per command** · **Burst:** 4 · **Refill:** 0.8 req/s This DELETE has its own bucket. The POST is configured identically, but uses a separate bucket. Cancel an in-progress `play_and_get_digits` on this session. Interrupts the prompt/collect cycle; the resulting `digits.collected` carries `status: cancelled`. Applies to the most recently dispatched `play_and_get_digits`; with none in progress the request is accepted and has no effect. Residual latency: cancellation stops prompt audio promptly, but the cancelled command's terminal `digits.collected` (`status: cancelled`) does not fire until the in-progress collect phase ends on the media layer's own timers — it is not delivered the instant you call DELETE. Input entered after a cancel is discarded — reported on the cancelled command's `digits.collected` event, never delivered to a later command.

Authentication

AuthorizationBearer
Application auth. Send `Authorization: Bearer <app_uuid>:<api_key>`. See [Authentication](https://voice-platform.docs.buildwithfern.com/api/authentication) for details.

Path parameters

uuidstringRequired

Session UUID (format {5-char-prefix}-{uuid}).

Query parameters

operation_uuidstringOptionalformat: "uuid"

Client-supplied UUID to label this cancel operation; must be a valid UUID or the request is rejected with 400; a UUID is generated when omitted. Echoed back as operation_uuid in the 202 response and on the resulting webhook.

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