End an active call

DELETE/api/v1/domains/{domain_uuid}/active-calls/{call_uuid}

End an active call. The call disconnects immediately when the request succeeds.

This request ends the selected call.

Path parameters

domain_uuidstringrequired

Your company ID supplied by Junction Cloud Connections. Use the same ID throughout your requests.

call_uuidstringrequired

The active call UUID.

Responses

200Success

objectstring

uuidstring

deletedboolean

400Invalid call UUID

errorobject

Show nested fields

typestring

messagestring

codestring

paramstring

401Unauthenticated

errorobject

Show nested fields

typestring

messagestring

codestring

404Active call not found

errorobject

Show nested fields

typestring

messagestring

codestring

paramstring

500Internal server error

errorobject

Show nested fields

typestring

messagestring

codestring

REQUEST EXAMPLE

Replace the host, token and example IDs with your account details.

curl --request DELETE \
  --url "https://YOUR-PORTAL-HOST/api/v1/domains/YOUR_COMPANY_UUID/active-calls/c0ec8113-aa15-40ac-8437-47185dd9dcf4" \
  --header "Authorization: Bearer $JUNCTIONCC_API_TOKEN" \
  --header "Accept: application/json"

const token = process.env.JUNCTIONCC_API_TOKEN;

const response = await fetch("https://YOUR-PORTAL-HOST/api/v1/domains/YOUR_COMPANY_UUID/active-calls/c0ec8113-aa15-40ac-8437-47185dd9dcf4", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${token}`,
    Accept: "application/json"
  }
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const text = await response.text();
console.log(text ? JSON.parse(text) : null);

import json
import os
from urllib.request import Request, urlopen

request = Request(
    "https://YOUR-PORTAL-HOST/api/v1/domains/YOUR_COMPANY_UUID/active-calls/c0ec8113-aa15-40ac-8437-47185dd9dcf4",
    method="DELETE",
    headers={
        "Authorization": "Bearer " + os.environ["JUNCTIONCC_API_TOKEN"],
        "Accept": "application/json"
    }
)
with urlopen(request, timeout=30) as response:
    body = response.read()
    print(json.loads(body) if body else None)

RESPONSE EXAMPLE

{
  "object": "active_call",
  "uuid": "c0ec8113-aa15-40ac-8437-47185dd9dcf4",
  "deleted": true
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "Invalid call UUID.",
    "code": "invalid_request",
    "param": "call_uuid"
  }
}

{
  "error": {
    "type": "authentication_error",
    "message": "Unauthenticated.",
    "code": "unauthenticated"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "Active call not found.",
    "code": "resource_missing",
    "param": "call_uuid"
  }
}

{
  "error": {
    "type": "api_error",
    "message": "Internal server error.",
    "code": "internal_error"
  }
}