Skip to main content

Softphones

Manage and configure softphone applications for voice communication.

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?filter_device_type=softphone" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Accept: application/json"

Overview​

Softphones are software-based telephone applications that can be installed on computers, tablets, and smartphones. They register as SIP devices in the Audian system.

Supported Platforms​

PlatformTypeExamples
DesktopWindows/MacZoiper, Bria, Linphone
MobileiOS/AndroidZoiper, Bria Mobile
BrowserWebWebRTC clients

List Softphones​

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

Create Softphone 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": "Alice Softphone",
      "device_type": "softphone",
      "owner_id": "user_123456",
      "sip": {
        "username": "alice_softphone",
        "password": "secure_password"
      },
      "caller_id": {
        "internal": {
          "number": "1001",
          "name": "Alice Smith"
        }
      }
    }
  }'

Response​

{
  "auth_token": "eyJhbGciOiJSUzI1...",
  "data": {
    "id": "device_softphone_123",
    "name": "Alice Softphone",
    "device_type": "softphone",
    "owner_id": "user_123456",
    "enabled": true,
    "sip": {
      "username": "alice_softphone",
      "realm": "sip.audian.com"
    }
  },
  "status": "success"
}

Configure Softphone Client​

Use these settings to configure your softphone application:

SettingValue
SIP Serversip.audian.com
SIP Port5060 (UDP) or 5061 (TLS)
UsernameYour SIP username from device creation
PasswordYour SIP password from device creation
Realmsip.audian.com

Example Configuration (Zoiper)​

  1. Open Zoiper Settings
  2. Add new SIP account
  3. Enter the SIP credentials from your device
  4. Set server to sip.audian.com
  5. Enable TCP/TLS for better reliability

Check Registration Status​

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

Response​

{
  "auth_token": "eyJhbGciOiJSUzI1...",
  "data": {
    "registered": true,
    "ip": "203.0.113.50",
    "port": 52415,
    "last_registration": "2026-02-04T14:30:00Z"
  },
  "status": "success"
}

Update Softphone​

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": "Alice Softphone - Home",
      "enabled": true
    }
  }'

Delete Softphone​

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

Troubleshooting​

Registration Fails​

  1. Verify credentials are correct
  2. Check network connectivity
  3. Verify firewall allows SIP (ports 5060/5061)
  4. Check NAT/STUN settings in your softphone

No Audio​

  1. Check audio device permissions
  2. Verify microphone/speaker are not muted
  3. Check firewall allows RTP (ports 16384-32768)
  4. Try different audio codec settings

Call Quality Issues​

  1. Check network bandwidth (minimum 100kbps per call)
  2. Enable jitter buffer in softphone settings
  3. Use wired connection instead of WiFi
  4. Try G.711 codec for best quality