Devices API

The Devices API allows you to manage communication devices within your Audian account, including SIP phones, softphones, and other endpoints.

Base URL

https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/devices

Authentication

All requests require the X-Auth-Token header:

curl -X GET "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/devices" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Accept: application/json"

Device Types

Type	Description
sip_device	SIP-registered hardware phones
softphone	Software-based phone applications
cellphone	Mobile phone for call forwarding
fax	Fax machine or ATA

List Devices

Get all devices in your account:

curl -X GET "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/devices?paginate=false" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Accept: application/json"

Response

{
  "auth_token": "eyJhbGciOiJSUzI1...",
  "data": [
    {
      "id": "device_abc123",
      "name": "John's Desk Phone",
      "device_type": "sip_device",
      "enabled": true,
      "owner_id": "user_xyz789",
      "sip": {
        "username": "device_abc123",
        "realm": "sip.audian.com"
      }
    }
  ],
  "request_id": "req_xyz789",
  "status": "success"
}

Get Device

Retrieve a specific device:

curl -X GET "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/devices/{DEVICE_ID}" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Accept: application/json"

Create Device

curl -X PUT "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/devices" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "name": "Reception Phone",
      "device_type": "sip_device",
      "owner_id": "user_xyz789",
      "sip": {
        "username": "reception_001",
        "password": "secure_password"
      },
      "caller_id": {
        "internal": {
          "number": "1001",
          "name": "Reception"
        }
      }
    }
  }'

Update Device

curl -X POST "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/devices/{DEVICE_ID}" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "name": "Reception Phone - Main",
      "enabled": true
    }
  }'

Delete Device

curl -X DELETE "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/devices/{DEVICE_ID}" \
  -H "X-Auth-Token: {AUTH_TOKEN}"

Device Fields

Field	Type	Description
id	string	Unique device identifier
name	string	Device display name
device_type	string	Type of device
owner_id	string	User who owns this device
enabled	boolean	Whether device is enabled
sip.username	string	SIP authentication username
sip.password	string	SIP authentication password
caller_id	object	Caller ID settings

Device Status

Status	Description
registered	Device is currently registered
unregistered	Device is not registered
disabled	Device is disabled

Filter Devices

# Filter by device type
GET /v2/accounts/{ACCOUNT_ID}/devices?filter_device_type=sip_device

# Filter by enabled status
GET /v2/accounts/{ACCOUNT_ID}/devices?filter_enabled=true

# Filter by owner
GET /v2/accounts/{ACCOUNT_ID}/devices?filter_owner_id={USER_ID}

Check Device Registration

curl -X GET "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/devices/{DEVICE_ID}/status" \
  -H "X-Auth-Token: {AUTH_TOKEN}"

Topics

• SIP Devices - Configure SIP phones
• Softphones - Software phone setup
• Registration - Monitor device registration