Management

Whisper call

The API endpoint allows you to whisper to an active call. The request should include the following parameters in x-www-form-urlencoded format:

  • extension (Required): Please enter the extension number of the listening manager.

  • format: The format of the response.

  • channel: Please enter the channel of the active call you want to whisper to.

  • cdrId: Please enter the “cdrid” for the active call you want to whisper to.

  • uniqueId: Please enter the “uniqueid” for the active call you want to whisper to.

The response to this request will include:

  • success: Indicates the success status of the whisper action.

  • message: Provides additional information or error message related to the whisper action.

post/api/whisper

Request

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

Request body application/x-www-form-urlencoded

cdrIdstring
channelstring
extensionstring
formatstring
uniqueIdstring

Example request

{
  "cdrId": "<string>",
  "channel": "<string>",
  "extension": "<string>",
  "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.