Skip to main content

Voicemail Greetings

Configure and manage greeting messages that callers hear when they reach a voicemail box. Use custom audio or text-to-speech.

Endpoints​

Set Greeting​

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

Get Current Greeting​

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

Update Greeting​

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

Delete Greeting​

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

Set Greeting​

Create or update a greeting message for a voicemail box.

Request​

curl -X POST https://api.audian.com:8443/v2/voicemail/boxes/box_abc123def456/greeting \
  -H "X-Auth-Token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "custom",
    "media_id": "media_greeting_123",
    "name": "Standard Greeting"
  }'

Headers​

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

Parameters​

ParameterTypeRequiredDescription
typeStringYesGreeting type (custom, tts, default)
media_idStringConditionalMedia file ID (required for custom)
textStringConditionalText for TTS (required for tts)
voiceStringNoVoice for TTS (default: en-US-neural-2)
nameStringNoGreeting name/label

Examples​

Custom Audio Greeting​

curl -X POST https://api.audian.com:8443/v2/voicemail/boxes/box_abc123def456/greeting \
  -H "X-Auth-Token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "custom",
    "media_id": "media_greeting_123",
    "name": "Professional Greeting"
  }'

Text-to-Speech Greeting​

curl -X POST https://api.audian.com:8443/v2/voicemail/boxes/box_abc123def456/greeting \
  -H "X-Auth-Token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "tts",
    "text": "Thank you for calling. Please leave a message and we will get back to you shortly.",
    "voice": "en-US-neural-2",
    "name": "Auto-generated Greeting"
  }'

JavaScript/Node.js​

const axios = require('axios');

const setGreeting = async (boxId, type, media_id, name) => {
  try {
    const response = await axios.post(
      `https://api.audian.com:8443/v2/voicemail/boxes/${boxId}/greeting`,
      {
        type: type,
        media_id: media_id,
        name: name
      },
      {
        headers: {
          'Authorization': 'Bearer YOUR_API_KEY',
          'Content-Type': 'application/json'
        }
      }
    );
    console.log('Greeting set:', response.data);
    return response.data;
  } catch (error) {
    console.error('Failed to set greeting:', error);
  }
};

// Usage
setGreeting(
  'box_abc123def456',
  'custom',
  'media_greeting_123',
  'Professional Greeting'
);

Python​

import requests

def set_greeting(api_key, box_id, greeting_type, media_id=None, 
                text=None, voice='en-US-neural-2', name=None):
    url = f'https://api.audian.com:8443/v2/voicemail/boxes/{box_id}/greeting'
    headers = {
        'X-Auth-Token': api_key,
        'Content-Type': 'application/json'
    }
    
    payload = {
        'type': greeting_type,
        'voice': voice
    }
    
    if media_id:
        payload['media_id'] = media_id
    
    if text:
        payload['text'] = text
    
    if name:
        payload['name'] = name
    
    response = requests.post(url, headers=headers, json=payload)
    return response.json()

# Usage
result = set_greeting(
    api_key='YOUR_API_KEY',
    box_id='box_abc123def456',
    greeting_type='custom',
    media_id='media_greeting_123',
    name='Professional Greeting'
)
print(result)

Default Greeting​

curl -X POST https://api.audian.com:8443/v2/voicemail/boxes/box_abc123def456/greeting \
  -H "X-Auth-Token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "default",
    "name": "System Default"
  }'

Response Format​

Set Greeting Success (200)​

{
  "id": "greet_abc123",
  "box_id": "box_abc123def456",
  "type": "custom",
  "media_id": "media_greeting_123",
  "name": "Professional Greeting",
  "duration": 8,
  "audio_url": "https://api.audian.com:8443/v2/voicemail/greetings/greet_abc123/audio",
  "created_at": "2024-02-04T12:15:00Z",
  "updated_at": "2024-02-04T12:15:00Z"
}

Get Current Greeting Success (200)​

{
  "id": "greet_abc123",
  "box_id": "box_abc123def456",
  "type": "custom",
  "media_id": "media_greeting_123",
  "name": "Professional Greeting",
  "duration": 8,
  "audio_url": "https://api.audian.com:8443/v2/voicemail/greetings/greet_abc123/audio",
  "set_at": "2024-02-04T12:15:00Z"
}

Update Greeting​

Change the greeting for a voicemail box.

curl -X PUT https://api.audian.com:8443/v2/voicemail/boxes/box_abc123def456/greeting \
  -H "X-Auth-Token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "custom",
    "media_id": "media_greeting_456",
    "name": "Updated Greeting"
  }'

Get Current Greeting​

Retrieve the currently active greeting for a voicemail box.

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

Download Greeting​

Get the audio file of a greeting.

curl -X GET https://api.audian.com:8443/v2/voicemail/greetings/greet_abc123/audio \
  -H "X-Auth-Token: YOUR_API_KEY" \
  -o greeting.wav

Greeting Types​

Custom Greeting​

  • Use pre-recorded audio files
  • Full control over message content and tone
  • Professional and personalized
  • Upload media file before creating greeting

Text-to-Speech Greeting​

  • Auto-generate from written text
  • Multiple voice options available
  • Quick to create and update
  • No upload required

Default Greeting​

  • System-provided greeting
  • Generic but professional
  • Useful for temporary setup

Greeting Best Practices​

  1. Professional Tone: Keep greetings professional and friendly
  2. Concise Message: Keep greetings brief (under 15 seconds)
  3. Clear Audio: Use clear, high-quality audio
  4. Regular Updates: Update for after-hours or special messages
  5. Testing: Test greeting before making it active
  6. Consistency: Use consistent naming for easy management

Common Greeting Templates​

Business Hours (Custom)​

{
  "type": "custom",
  "media_id": "media_business_hours",
  "name": "Business Hours Greeting"
}

After Hours (TTS)​

{
  "type": "tts",
  "text": "Thank you for calling. Our office is closed. Regular hours are Monday through Friday, 9 AM to 5 PM. Please leave a message and we will return your call tomorrow.",
  "voice": "en-US-neural-2",
  "name": "After Hours"
}

Holiday Greeting (Custom)​

{
  "type": "custom",
  "media_id": "media_holiday_greeting",
  "name": "Holiday Closure"
}

Seasonal Message (TTS)​

{
  "type": "tts",
  "text": "Happy New Year! Our team will be returning on January 2nd. We appreciate your business.",
  "voice": "en-US-neural-4",
  "name": "New Year Greeting"
}

Switching Greetings​

Quickly switch between multiple greetings:

const greetings = {
  business: 'media_business_hours',
  afterHours: 'media_after_hours',
  holiday: 'media_holiday'
};

const setGreetingByTime = async (boxId) => {
  const now = new Date();
  const hour = now.getHours();
  
  if (hour >= 9 && hour < 17) {
    await setGreeting(boxId, 'custom', greetings.business);
  } else {
    await setGreeting(boxId, 'custom', greetings.afterHours);
  }
};

Limits and Quotas​

  • Max greeting duration: 5 minutes
  • Max greetings per box: 10 (stored)
  • Max text length: 5000 characters
  • Voice options: 12 different voices available
  • Update frequency: No limit on changes
  • Download bandwidth: Unlimited