Skip to main content

Voicemail Boxes

Create and manage voicemail boxes for receiving and storing messages. Each box can be customized with greetings and notification settings.

Endpoints​

Create Voicemail Box​

POST https://api.audian.com:8443/v2/voicemail/boxes

List Voicemail Boxes​

GET https://api.audian.com:8443/v2/voicemail/boxes

Get Box Details​

GET https://api.audian.com:8443/v2/voicemail/boxes/{boxId}

Update Box Settings​

PUT https://api.audian.com:8443/v2/voicemail/boxes/{boxId}

Delete Voicemail Box​

DELETE https://api.audian.com:8443/v2/voicemail/boxes/{boxId}

Create Voicemail Box​

Create a new voicemail box for receiving messages.

Request​

curl -X POST https://api.audian.com:8443/v2/voicemail/boxes \
  -H "X-Auth-Token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Smith Voicemail",
    "owner": "john.smith@company.com",
    "max_message_length": 600,
    "max_messages": 100,
    "allow_caller_id": true
  }'

Headers​

Content-Type: application/json
X-Auth-Token: YOUR_API_KEY

Parameters​

ParameterTypeRequiredDescription
nameStringYesBox name or owner name
ownerStringNoEmail or ID of box owner
max_message_lengthNumberNoMax message duration in seconds (default: 600)
max_messagesNumberNoMaximum messages to store (default: 100)
allow_caller_idBooleanNoRecord caller ID (default: true)
require_login_pinBooleanNoRequire PIN to access (default: false)
login_pinStringNo4-6 digit PIN code

Examples​

JavaScript/Node.js​

const axios = require('axios');

const createVoicemailBox = async (name, owner) => {
  try {
    const response = await axios.post(
      'https://api.audian.com:8443/v2/voicemail/boxes',
      {
        name: name,
        owner: owner,
        max_message_length: 600,
        max_messages: 100,
        allow_caller_id: true,
        require_login_pin: true,
        login_pin: '1234'
      },
      {
        headers: {
          'Authorization': 'Bearer YOUR_API_KEY',
          'Content-Type': 'application/json'
        }
      }
    );
    console.log('Voicemail box created:', response.data);
    return response.data;
  } catch (error) {
    console.error('Failed to create box:', error);
  }
};

// Usage
createVoicemailBox('John Smith', 'john@company.com');

Python​

import requests

def create_voicemail_box(api_key, name, owner=None, max_message_length=600,
                        max_messages=100, allow_caller_id=True,
                        require_login_pin=False, login_pin=None):
    url = 'https://api.audian.com:8443/v2/voicemail/boxes'
    headers = {
        'X-Auth-Token': api_key,
        'Content-Type': 'application/json'
    }
    
    payload = {
        'name': name,
        'max_message_length': max_message_length,
        'max_messages': max_messages,
        'allow_caller_id': allow_caller_id,
        'require_login_pin': require_login_pin
    }
    
    if owner:
        payload['owner'] = owner
    
    if login_pin:
        payload['login_pin'] = login_pin
    
    response = requests.post(url, headers=headers, json=payload)
    return response.json()

# Usage
result = create_voicemail_box(
    api_key='YOUR_API_KEY',
    name='John Smith',
    owner='john@company.com',
    require_login_pin=True,
    login_pin='1234'
)
print(result)

Create Multiple Department Boxes​

curl -X POST https://api.audian.com:8443/v2/voicemail/boxes \
  -H "X-Auth-Token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Sales Department",
    "max_message_length": 300,
    "max_messages": 200,
    "allow_caller_id": true
  }'

Response​

Create Success (201)​

{
  "id": "box_abc123def456",
  "name": "John Smith Voicemail",
  "owner": "john.smith@company.com",
  "status": "active",
  "greeting_id": null,
  "max_message_length": 600,
  "max_messages": 100,
  "current_messages": 0,
  "allow_caller_id": true,
  "require_login_pin": true,
  "login_pin": "****",
  "created_at": "2024-02-04T12:00:00Z",
  "updated_at": "2024-02-04T12:00:00Z"
}

List Success (200)​

{
  "boxes": [
    {
      "id": "box_abc123def456",
      "name": "John Smith",
      "owner": "john.smith@company.com",
      "status": "active",
      "current_messages": 5,
      "max_messages": 100,
      "created_at": "2024-02-04T12:00:00Z"
    },
    {
      "id": "box_xyz789",
      "name": "Jane Doe",
      "owner": "jane.doe@company.com",
      "status": "active",
      "current_messages": 2,
      "max_messages": 100,
      "created_at": "2024-02-04T11:45:00Z"
    }
  ],
  "total": 2,
  "limit": 50,
  "offset": 0
}

Update Box Settings​

Change voicemail box settings after creation.

curl -X PUT https://api.audian.com:8443/v2/voicemail/boxes/box_abc123def456 \
  -H "X-Auth-Token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "max_message_length": 900,
    "max_messages": 150,
    "allow_caller_id": false
  }'

Delete Voicemail Box​

Remove a voicemail box. Messages may be archived before deletion.

curl -X DELETE https://api.audian.com:8443/v2/voicemail/boxes/box_abc123def456 \
  -H "X-Auth-Token: YOUR_API_KEY"

Box Settings​

Message Length Options​

DurationUse Case
300Quick messages only
600Standard voicemail
1800Detailed messages

Message Capacity​

CapacityUse Case
50Individual/light use
100Standard user
500Department/shared box
1000High-volume department

Best Practices​

  1. Naming: Use clear, descriptive names for boxes
  2. PIN Security: Use unique PINs for security-sensitive boxes
  3. Capacity: Set appropriate message limits
  4. Owner Assignment: Clearly assign box owners
  5. Regular Cleanup: Archive old messages regularly
  6. Testing: Test greeting and message recording before deployment

Typical Configuration​

Executive Box​

{
  "name": "Executive Assistant",
  "max_message_length": 300,
  "max_messages": 50,
  "require_login_pin": true
}

Department Box​

{
  "name": "Customer Support",
  "max_message_length": 600,
  "max_messages": 500,
  "allow_caller_id": true
}

Sales Box​

{
  "name": "Sales Team",
  "max_message_length": 900,
  "max_messages": 200,
  "require_login_pin": false
}

Limits and Quotas​

  • Max boxes per account: 1000
  • Max message length: 1 hour (configurable per box)
  • Max messages per box: Limited by storage
  • PIN length: 4-6 digits
  • Name length: 255 characters
  • Default storage: 1GB per account (upgradeable)