Devices

Create device

Create a new device (extension).

When to use. Provision a new extension that can register and place or receive calls.

Request body. extension (required): an integer between 100 and 9999. name (required): a label for the device. A registration password is generated automatically and returned in the response.

Shape. { "devices": [ <device> ] } for the created device, including its generated password.

post/{sub_domain}/api/devices

Request

  • Base URL
    https://api.commpeak.com/dialer
  • URL
    https://api.commpeak.com/dialer/{sub_domain}/api/devices
  • Auth
    API key in header Authorization

Path parameters

sub_domainstring required

Dialer Name (subdomain)

Request body

extensionstring required

Device extension. Must be an integer between 100 and 9999.

namestring required

Device name / description.

Response

Successful Response

Example response

{
  "devices": [
    {
      "created_at": "2023-07-13 09:47:56",
      "extension": 199,
      "id": 1,
      "name": "dev-agent",
      "password": "69a9f6eddfd521fce4366c945a95cab5"
    }
  ]
}

Changes

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