---
title: "Hangup call"
method: POST
path: "/api/hangup"
tags: ["Management"]
---

# Hangup call

`POST /api/hangup`

## Request

- Base URL: `https://your-instance.stats.pbx.commpeak.com`
- URL: `https://your-instance.stats.pbx.commpeak.com/api/hangup`
- Auth: API key in header `X-API-KEY`

### Hangup Call

This endpoint allows you to hang up a call by providing the unique ID of the call.

#### Request Body Parameters

- `uniqueId` (required): Please enter the “uniqueid” of a call you would like to hang up.
    
- `format`: The format of the response.
    

#### Response

The response will include the following fields:

- `success`: Indicates the success status of the hangup operation.
    
- `message`: Provides additional information or error message, if applicable.
    

#### Example

``` json
{
    "success": "",
    "message": ""
}

 ```

## Request body `application/x-www-form-urlencoded`

- object
  - `format` string
  - `uniqueId` string

## Response `200`

successful

- object
  - `message` string
  - `success` string

## Other responses

- `400`: Error: Bad Request
- `401`: Unauthorized

---

[API](https://skmtc.dev/commpeak/apis/pbx-stats-api.md) - [All operations](https://skmtc.dev/commpeak/apis/pbx-stats-api/llms.txt) - [OpenAPI document](https://skmtc.dev/commpeak/apis/pbx-stats-api/revisions/2f599eb625f8?raw)