Manage Agents

Add Device

Add Device


Description

This endpoint is used to add a new device to the PBX system.

Request Body

  • deviceID (text, Required): Give your device a unique integer ID. The device will use this ID to authenticate to the system.

  • description (text, Required): The CallerID name for this device will be set to this description until it is logged into.

  • deviceType (text, Required): Devices can be fixed or adhoc. Fixed devices are always associated to the same extension/user. Adhoc devices can be logged into and logged out of by users. ** MISSING FEATURE CODE ** logs into a device. ** MISSING FEATURE CODE ** logs out of a device.

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

Response

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

post/api/addDevice

Request

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

Request body application/x-www-form-urlencoded

descriptionstring
deviceIDstring
deviceTypestring
formatstring

Example request

{
  "description": "<string>",
  "deviceID": "<number>",
  "deviceType": "fixed",
  "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.