Management

Hangup call

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

{
    "success": "",
    "message": ""
}

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

Request body application/x-www-form-urlencoded

formatstring
uniqueIdstring

Example request

{
  "format": "json",
  "uniqueId": "<string>"
}

Response

successful

messagestring
successstring

Example response

{
  "message": "<string>",
  "success": "<boolean>"
}

Changes

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