Skip to main content

Number Configuration

Configure call handling, routing, and features for your phone numbers.

Update Number Configuration​

Modify settings for a specific phone number.

Endpoint​

PUT https://api.audian.com:8443/v2/numbers/{number_id}/config

Parameters​

ParameterTypeRequiredDescription
friendly_namestringNoUser-friendly name for the number
call_forwardingobjectNoCall forwarding configuration
voicemailobjectNoVoicemail settings
sms_webhookstringNoWebhook URL for incoming SMS
voice_webhookstringNoWebhook URL for incoming calls

Call Forwarding Object​

{
  "enabled": true,
  "forward_to": "+14155559999",
  "when_unavailable": true,
  "rings_before_forward": 5
}

Voicemail Object​

{
  "enabled": true,
  "transcription": true,
  "delete_after_days": 30
}

Request Example​

curl -X PUT 'https://api.audian.com:8443/v2/numbers/num_abc123/config' \
  -H 'X-Auth-Token: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "friendly_name": "Support Line",
    "call_forwarding": {
      "enabled": true,
      "forward_to": "+14155559999",
      "rings_before_forward": 4
    },
    "voicemail": {
      "enabled": true,
      "transcription": true
    }
  }'

Response​

{
  "success": true,
  "data": {
    "id": "num_abc123",
    "number": "+14155551234",
    "friendly_name": "Support Line",
    "call_forwarding": {
      "enabled": true,
      "forward_to": "+14155559999",
      "rings_before_forward": 4
    },
    "voicemail": {
      "enabled": true,
      "transcription": true,
      "delete_after_days": 30
    }
  }
}

Get Number Configuration​

Retrieve the current configuration for a number.

Endpoint​

GET https://api.audian.com:8443/v2/numbers/{number_id}/config

Request Example​

curl -X GET 'https://api.audian.com:8443/v2/numbers/num_abc123/config' \
  -H 'X-Auth-Token: YOUR_API_KEY'

Call Forwarding​

Forward incoming calls to another number.

Features​

  • Multiple Forward Numbers: Set different forwarding rules by time of day
  • Ring Count: Configure how many times to ring before forwarding
  • Unavailable Forwarding: Forward when number is busy or unreachable
  • Voicemail Backup: Forward to voicemail if final destination doesn't answer

Configuration Example​

{
  "call_forwarding": {
    "enabled": true,
    "forward_to": "+14155559999",
    "when_unavailable": true,
    "rings_before_forward": 5
  }
}

Voicemail Configuration​

Set up and manage voicemail for your numbers.

Features​

  • Voicemail Transcription: Automatically transcribe voicemail to text
  • Voicemail Notifications: Receive alerts when voicemails are left
  • Auto Retention: Automatically delete voicemails after specified days
  • Greetings: Set custom voicemail greetings

Configuration Example​

{
  "voicemail": {
    "enabled": true,
    "transcription": true,
    "delete_after_days": 30,
    "greeting": "custom"
  }
}

Webhooks​

Receive HTTP callbacks for incoming calls and SMS.

SMS Webhook​

Triggered when an SMS is received on the number.

Payload:

{
  "event": "sms.received",
  "number": "+14155551234",
  "from": "+14155559999",
  "message": "Hello, this is a test message",
  "received_at": "2024-01-15T10:30:00Z"
}

Voice Webhook​

Triggered when a call is received on the number.

Payload:

{
  "event": "call.received",
  "number": "+14155551234",
  "from": "+14155559999",
  "received_at": "2024-01-15T10:30:00Z"
}

Webhook Best Practices​

  • Validate Requests: Verify webhook signatures for security
  • Handle Retries: Implement idempotent webhook handlers
  • Use Queues: Process webhooks asynchronously
  • Monitor Status: Track successful and failed webhook deliveries
  • HTTPS Only: Use HTTPS URLs for webhook endpoints

Time-Based Routing​

Configure different call handling rules for different times.

Example use cases:

  • Route calls to support team during business hours
  • Forward to voicemail after hours
  • Different routing on weekends

Best Practices​

  1. Test Before Deployment: Test all configuration changes
  2. Monitor Webhook Delivery: Ensure webhooks are being received
  3. Use Friendly Names: Make number purposes clear
  4. Set Reasonable Ring Counts: 3-5 rings is typical
  5. Enable Transcription: Get text transcripts of voicemails
  6. Backup Routing: Always have a fallback plan

Limits​

  • Maximum 10 configured numbers per API key
  • Webhook delivery timeout: 30 seconds
  • Voicemail retention: 1-365 days