Voicemail System

The Voicemail API allows you to create and manage voicemail boxes, configure greetings, retrieve messages, and set up notifications.

Base URL

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

Authentication

All requests require the X-Auth-Token header:

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

List Voicemail Boxes

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

Response

{
  "auth_token": "eyJhbGciOiJSUzI1...",
  "data": [
    {
      "id": "vmbox_abc123",
      "name": "John Doe Voicemail",
      "mailbox": "1001",
      "owner_id": "user_xyz789",
      "timezone": "America/New_York",
      "pin": "1234",
      "require_pin": true
    }
  ],
  "request_id": "req_xyz789",
  "status": "success"
}

Create Voicemail Box

curl -X PUT "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/vmboxes" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "name": "Sales Team Voicemail",
      "mailbox": "2001",
      "owner_id": "user_xyz789",
      "pin": "5678",
      "require_pin": true,
      "timezone": "America/New_York",
      "skip_greeting": false,
      "skip_instructions": false
    }
  }'

Get Voicemail Box

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

Update Voicemail Box

curl -X POST "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/vmboxes/{VMBOX_ID}" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "name": "Updated Voicemail Name",
      "pin": "9999"
    }
  }'

Delete Voicemail Box

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

Voicemail Box Fields

Field	Type	Description
id	string	Unique voicemail box identifier
name	string	Display name
mailbox	string	Mailbox number/extension
owner_id	string	User who owns this voicemail
pin	string	Access PIN
require_pin	boolean	Require PIN to access
timezone	string	Timezone for timestamps
skip_greeting	boolean	Skip greeting playback
skip_instructions	boolean	Skip instruction playback
is_setup	boolean	Has greeting been recorded

List Messages

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

Response

{
  "auth_token": "eyJhbGciOiJSUzI1...",
  "data": [
    {
      "media_id": "msg_abc123",
      "caller_id_number": "+14155559999",
      "caller_id_name": "Jane Smith",
      "timestamp": "2026-02-04T10:30:00Z",
      "length": 45,
      "folder": "new"
    }
  ],
  "status": "success"
}

Get Message Audio

curl -X GET "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/vmboxes/{VMBOX_ID}/messages/{MESSAGE_ID}/raw" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Accept: audio/mpeg" \
  --output message.mp3

Delete Message

curl -X DELETE "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/vmboxes/{VMBOX_ID}/messages/{MESSAGE_ID}" \
  -H "X-Auth-Token: {AUTH_TOKEN}"

Message Folders

Folder	Description
new	Unread messages
saved	Read/saved messages
deleted	Messages marked for deletion

Notification Settings

Configure email notifications for new voicemails by updating the voicemail box:

curl -X POST "https://api.audian.com:8443/v2/accounts/{ACCOUNT_ID}/vmboxes/{VMBOX_ID}" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "notify_email_addresses": ["user@example.com"],
      "delete_after_notify": false
    }
  }'

Topics

• Voicemail Boxes - Create and manage boxes
• Messages - Retrieve and manage messages
• Greetings - Configure greetings
• Notifications - Set up alerts