v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB

Call

Delete up the call

Delete the call

delete/calls/{id}

Path parameters

idstring required

Response

The result of the deleted call info.

idstring uuid

The unique identifier of the call.

customer_idstring uuid

The customer ID that owns this call. Returned from the GET /customers response.

owner_typestring

Type of the resource owner (e.g., agent, queue).

owner_idstring uuid

The unique identifier of the resource owner. Returned from the corresponding owner resource endpoint (e.g., GET /agents, GET /queues).

flow_idstring uuid

The flow ID associated with this call. Returned from the POST /flows or GET /flows response.

activeflow_idstring uuid

The activeflow ID associated with this call. Returned from the POST /activeflows or GET /activeflows response.

type'' | 'flow' | 'conference' | 'sip-service'

Call type

master_call_idstring uuid

The unique identifier of the master call that initiated this call. Returned from the POST /calls or GET /calls response.

chained_call_idsstring[]

Chained call IDs. Each ID is returned from the POST /calls or GET /calls response.

recording_idstring uuid

The current recording ID. Returned from the GET /recordings response.

recording_idsstring[]

Recording IDs associated with this call. Each ID is returned from the GET /recordings response.

groupcall_idstring uuid

Group call ID. Returned from the POST /groupcalls or GET /groupcalls response. Indicates this call is part of a group call.

Call status

direction'incoming' | 'outgoing'

Call direction

mute_direction'' | 'both' | 'out' | 'in'

Possible mute directions for the call

hangup_by'' | 'remote' | 'local'

Indicates who hung up the call

Reason for call hangup

metadataobject nullable

Internal metadata for the call. Contains key-value pairs set by the system. Currently supported keys:

rtp_debug (boolean): When true, RTPEngine is capturing RTP traffic for this call.

tm_progressingstring date-time

Timestamp for call progressing.

tm_ringingstring date-time

Timestamp for call ringing.

tm_hangupstring date-time

Timestamp for call hangup.

tm_createstring date-time

The creation timestamp.

tm_updatestring date-time

The last update timestamp.

tm_deletestring date-time

The deletion timestamp, if applicable.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "owner_type": "agent",
  "owner_id": "c2d3e4f5-a6b7-8901-2cde-f01234567890",
  "flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "activeflow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  "type": "flow",
  "master_call_id": "4d5e6f7a-8b9c-0123-def0-123456789012",
  "chained_call_ids": [
    "550e8400-e29b-41d4-a716-446655440000"
  ],
  "recording_id": "e5f6a7b8-c9d0-1234-5678-90abcdef0123",
  "recording_ids": [
    "e5f6a7b8-c9d0-1234-5678-90abcdef0123"
  ],
  "groupcall_id": "5e6f7a8b-9c0d-1234-ef01-234567890123",
  "source": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "destination": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "status": "progressing",
  "action": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "next_id": "550e8400-e29b-41d4-a716-446655440000",
    "type": "talk",
    "tm_execute": "2026-01-15T09:30:00.000000Z"
  },
  "direction": "outgoing",
  "mute_direction": "both",
  "hangup_by": "remote",
  "hangup_reason": "normal",
  "metadata": {
    "rtp_debug": true
  },
  "tm_progressing": "2026-01-15T09:30:00.000000Z",
  "tm_ringing": "2026-01-15T09:30:00.000000Z",
  "tm_hangup": "2026-01-15T09:30:00.000000Z",
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-15T09:30:00.000000Z",
  "tm_delete": "2026-01-15T09:30:00.000000Z"
}