Skip to navigation

Cancel outbound DTMF sequence

View as Markdown

Rate limit: Per command · Burst: 20 · Refill: 20 req/s

Cancel the active outbound DTMF sequence for the session. Before returning 202, the platform deletes the remaining sequence plan so that it cannot schedule another key or wait action. A key whose transmission has already started might still finish.

If no sequence is active, the platform accepts the request without taking further action. The 202 response acknowledges the cancellation request. The platform does not emit a terminal webhook.

See Keypad input lifecycle events for complete payload schemas and examples.

Authentication

AuthorizationBearer

Send Authorization: Bearer <app_uuid>:<api_key> using an active API key. See 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 headers

traceparentstringOptionalformat: "^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$"=55 characters

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.

Response

Cancellation accepted.
operation_uuidstring
statusenum
Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
406
Not Acceptable Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error