---
title: "Add Device"
method: POST
path: "/api/addDevice"
tags: ["Manage Agents"]
---

# Add Device

`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`

### 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

``` json
{
  "success": "",
  "message": ""
}

 ```

## Request body `application/x-www-form-urlencoded`

- object
  - `description` string
  - `deviceID` string
  - `deviceType` string
  - `format` string

## Response `200`

successful

- object
  - `message` string
  - `success` string

## Other responses

- `400`: Error: Bad Request
- `401`: Unauthorized

---

[API](https://skmtc.dev/commpeak/apis/pbx-stats-api.md) - [All operations](https://skmtc.dev/commpeak/apis/pbx-stats-api/llms.txt) - [OpenAPI document](https://skmtc.dev/commpeak/apis/pbx-stats-api/revisions/2f599eb625f8?raw)