Manage Agents

UnPause Agent

UnPause Agent

This endpoint allows you to unpause a specific agent using the following parameters:

  • agent: (Required) Enter the extension number you wish to unpause.

  • format: The format of the response.

API Response

The response will include the following fields:

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

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

post/api/unpause

Request

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

Request body application/x-www-form-urlencoded

agentstring
formatstring

Example request

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

Response

successful

messagestring
successstring

Example response

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

Changes

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