Pause Agent

This endpoint allows you to pause an agent by providing the extension number and the pause type ID.

Request Body

• agent (text, required): Enter the extension number you wish to pause.

• format (text): The format of the response.

• pauseId (text, required): Enter the ID of the Pause type. You can get the full list of pauses for your account by using the “PausesList” API method.

Response

The response will be in JSON format with the following fields:

• success: Indicates the success of the pause action.

• message: Provides additional information about the pause action.

Example

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

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

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