SIP Devices

Manage SIP-based communication devices including IP phones, adapters, and SIP endpoints.

Overview

SIP (Session Initiation Protocol) devices are hardware or software endpoints that register with the Audian SIP server. Common SIP devices include:

• IP phones (Polycom, Cisco, Avaya, Yealink)
• Analog Telephone Adapters (ATA)
• SIP gateways
• PBX systems
• Conference phones

Endpoints

POST /v1/accounts/{accountId}/devices/sip
GET /v1/accounts/{accountId}/devices/sip/{deviceId}
PATCH /v1/accounts/{accountId}/devices/sip/{deviceId}
DELETE /v1/accounts/{accountId}/devices/sip/{deviceId}
GET /v1/accounts/{accountId}/devices/sip/{deviceId}/credentials
POST /v1/accounts/{accountId}/devices/sip/{deviceId}/reset-password

Create SIP Device

Register a new SIP device.

Endpoint

POST https://api.audian.com:8443/v2/accounts/{accountId}/devices/sip

Request Body

Parameter	Type	Required	Description
name	string	Yes	Device name
model	string	No	Device model
manufacturer	string	No	Device manufacturer
macAddress	string	No	MAC address for provisioning
sipUsername	string	Yes	SIP username
displayName	string	No	Display name for caller ID
assignedUser	string	No	User ID for assignment

Example

curl -X POST https://api.audian.com:8443/v2/accounts/acc_1234567890/devices/sip \
  -H "Content-Type: application/json" \
  -H "X-Auth-Token: YOUR_API_TOKEN" \
  -d '{
    "name": "Desk Phone - John Doe",
    "model": "Yealink T46S",
    "manufacturer": "Yealink",
    "macAddress": "00:15:65:00:00:01",
    "sipUsername": "john.doe",
    "displayName": "John Doe",
    "assignedUser": "user_123456"
  }'

Response (201 Created)

{
  "id": "dev_sip_123456",
  "accountId": "acc_1234567890",
  "type": "sip",
  "name": "Desk Phone - John Doe",
  "model": "Yealink T46S",
  "manufacturer": "Yealink",
  "macAddress": "00:15:65:00:00:01",
  "sipUsername": "john.doe",
  "sipDomain": "sip.audian.com",
  "displayName": "John Doe",
  "status": "active",
  "registrationStatus": "pending",
  "assignedUser": "user_123456",
  "credentials": {
    "sipPassword": "xxxxxxxxxxxxxx"
  },
  "createdAt": "2023-10-20T10:00:00Z"
}

Retrieve SIP Device

Get details about a SIP device.

Endpoint

GET https://api.audian.com:8443/v2/accounts/{accountId}/devices/sip/{deviceId}

Example

curl -X GET https://api.audian.com:8443/v2/accounts/acc_1234567890/devices/sip/dev_sip_123456 \
  -H "X-Auth-Token: YOUR_API_TOKEN"

Response

{
  "id": "dev_sip_123456",
  "accountId": "acc_1234567890",
  "type": "sip",
  "name": "Desk Phone - John Doe",
  "model": "Yealink T46S",
  "status": "active",
  "sipUsername": "john.doe",
  "sipDomain": "sip.audian.com",
  "displayName": "John Doe",
  "ipAddress": "192.168.1.100",
  "macAddress": "00:15:65:00:00:01",
  "registrationStatus": "registered",
  "lastRegistration": "2023-10-20T14:30:00Z",
  "assignedUser": "user_123456",
  "createdAt": "2023-10-15T10:30:00Z",
  "updatedAt": "2023-10-20T14:30:00Z"
}

Update SIP Device

Modify a SIP device configuration.

Endpoint

PATCH https://api.audian.com:8443/v2/accounts/{accountId}/devices/sip/{deviceId}

Request Body

Parameter	Type	Description
name	string	Device name
displayName	string	Caller ID display name
assignedUser	string	Assigned user ID
status	string	Device status (active, inactive)

Example

curl -X PATCH https://api.audian.com:8443/v2/accounts/acc_1234567890/devices/sip/dev_sip_123456 \
  -H "Content-Type: application/json" \
  -H "X-Auth-Token: YOUR_API_TOKEN" \
  -d '{
    "displayName": "John Doe - Main Desk",
    "status": "active"
  }'

SIP Credentials

Get SIP Credentials

Retrieve SIP credentials for manual configuration.

curl -X GET https://api.audian.com:8443/v2/accounts/acc_1234567890/devices/sip/dev_sip_123456/credentials \
  -H "X-Auth-Token: YOUR_API_TOKEN"

Response

{
  "sipServer": "sip.audian.com",
  "sipPort": 5060,
  "sipUsername": "john.doe",
  "sipPassword": "xxxxxxxxxxxxxx",
  "sipDomain": "sip.audian.com",
  "outboundProxy": "sip.audian.com:5060",
  "transportProtocol": "UDP"
}

Reset SIP Password

Reset the SIP password for a device.

Endpoint

POST https://api.audian.com:8443/v2/accounts/{accountId}/devices/sip/{deviceId}/reset-password

Example

curl -X POST https://api.audian.com:8443/v2/accounts/acc_1234567890/devices/sip/dev_sip_123456/reset-password \
  -H "X-Auth-Token: YOUR_API_TOKEN"

Response

{
  "sipPassword": "NewRandomPassword123!",
  "message": "Password reset successfully",
  "expiresAt": "2023-10-20T20:00:00Z"
}

Delete SIP Device

Remove a SIP device from service.

Endpoint

DELETE https://api.audian.com:8443/v2/accounts/{accountId}/devices/sip/{deviceId}

Example

curl -X DELETE https://api.audian.com:8443/v2/accounts/acc_1234567890/devices/sip/dev_sip_123456 \
  -H "X-Auth-Token: YOUR_API_TOKEN"

SIP Configuration Reference

Server Settings

Primary SIP Server: sip.audian.com
Port: 5060 (UDP), 5061 (TLS)
Domain: audian.com
Outbound Proxy: sip.audian.com:5060

Supported Codecs

Codec	Priority
G.711 (ulaw)	1 (preferred)
G.711 (alaw)	2
G.729	3
Opus	4

Quality of Service (QoS)

RTP Port Range: 16000-32000
DSCP: EF (46)
Jitter Buffer: Adaptive

Troubleshooting

Registration Issues

1. Verify SIP credentials
2. Check network connectivity
3. Verify firewall rules allow SIP/RTP
4. Check NAT/firewall traversal settings
5. Review registration logs

No Audio Issues

1. Verify codec support
2. Check RTP port forwarding
3. Verify firewall rules for RTP
4. Check jitter buffer settings
5. Test with different codec

Configuration Issues

1. Verify SIP domain
2. Check outbound proxy settings
3. Verify registration expiry
4. Check authentication settings

Best Practices

1. Regular Updates: Keep device firmware up to date
2. Security: Use strong passwords, change defaults
3. Monitoring: Monitor registration status regularly
4. Backup Proxy: Configure backup SIP server
5. VLAN Configuration: Use QoS settings for optimal performance

Related Documentation

• Device Overview
• Device Provisioning
• Registration Monitoring
• WebRTC Devices