runs

Cancel a run

Cancel an active run. A phone call settles as cancelled after its media session ends.

post/api/v1/runs/{run_id}/cancel

Request

  • Base URL: https://api.cumuluslabs.io
  • URL: https://api.cumuluslabs.io/api/v1/runs/{run_id}/cancel
  • Auth: HTTP bearer

Path parameters

run_idstring uuid required

Request body

reasonstring

Response

Cancel an active run (accepted: a live call settles cancelled when its media session ends)

owner_idstring required
environmentstring required
tenant_idstring uuid required
run_idstring uuid required
agent_idstring required
plan_schema_versioninteger required
channel'cloud' | 'phone' | 'web' required
mode'task' | 'chat' | 'background' | 'outbound' | 'inbound' required
state'admitted' | 'running' | 'ending' | 'completed' | 'failed' | 'cancelled' | 'rejected' | 'expired' required
phone_state'admitted' | 'preparing' | 'awaiting_sip' | 'dialing' | 'ringing' | 'active' | 'terminating' | 'ended' | 'rejected' | 'expired' | 'setup_failed' nullable required
dispositionstring nullable required
attempt_countinteger required
created_atstring date-time required
started_atstring date-time nullable required
ended_atstring date-time nullable required
versioninteger required
tostring nullable required
fromstring nullable required
duration_msinteger nullable required
metadataobject required
testboolean required
provider_keysobject

Changes

No recorded changes to this operation across all 1 revision of this API.