Caller ID Configuration

Manage outbound caller ID settings for your phone numbers.

Overview

The Caller ID API allows you to:

• Set default caller ID for outbound calls
• Use multiple verified caller IDs
• Configure caller ID display names
• Verify new caller IDs

Set Default Caller ID

Configure the default caller ID for a phone number.

Endpoint

PUT https://api.audian.com:8443/v2/numbers/{number_id}/caller-id

Parameters

Parameter	Type	Required	Description
caller_id_number	string	Yes	Phone number to display (E.164 format)
caller_id_name	string	Yes	Name to display (max 15 characters)

Request Example

curl -X PUT 'https://api.audian.com:8443/v2/numbers/num_abc123/caller-id' \
  -H 'X-Auth-Token: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "caller_id_number": "+14155551234",
    "caller_id_name": "Support"
  }'

Response

{
  "success": true,
  "data": {
    "number": "+14155551234",
    "caller_id_number": "+14155551234",
    "caller_id_name": "Support",
    "status": "active",
    "verified": true
  }
}

Get Caller ID Settings

Retrieve the current caller ID configuration.

Endpoint

GET https://api.audian.com:8443/v2/numbers/{number_id}/caller-id

Request Example

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

Verified Caller IDs

List all verified caller IDs for your account.

Endpoint

GET https://api.audian.com:8443/v2/caller-ids

Response

{
  "success": true,
  "data": {
    "caller_ids": [
      {
        "id": "cid_abc123",
        "number": "+14155551234",
        "name": "Support",
        "status": "verified",
        "verified_at": "2024-01-15T10:30:00Z"
      },
      {
        "id": "cid_abc124",
        "number": "+14155551235",
        "name": "Sales",
        "status": "verified",
        "verified_at": "2024-01-15T10:30:00Z"
      }
    ]
  }
}

Add Caller ID

Add a new caller ID to your account.

Endpoint

POST https://api.audian.com:8443/v2/caller-ids

Parameters

Parameter	Type	Required	Description
number	string	Yes	Phone number in E.164 format
name	string	Yes	Display name (max 15 characters)

Request Example

curl -X POST 'https://api.audian.com:8443/v2/caller-ids' \
  -H 'X-Auth-Token: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "number": "+14155551234",
    "name": "Support"
  }'

Response

{
  "success": true,
  "data": {
    "id": "cid_abc123",
    "number": "+14155551234",
    "name": "Support",
    "status": "pending_verification",
    "verification_method": "sms"
  }
}

Verify Caller ID

Complete the verification process for a new caller ID.

Endpoint

POST https://api.audian.com:8443/v2/caller-ids/{caller_id}/verify

Parameters

Parameter	Type	Required	Description
verification_code	string	Yes	Code received via SMS or call

Request Example

curl -X POST 'https://api.audian.com:8443/v2/caller-ids/cid_abc123/verify' \
  -H 'X-Auth-Token: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "verification_code": "123456"
  }'

Response

{
  "success": true,
  "data": {
    "id": "cid_abc123",
    "number": "+14155551234",
    "name": "Support",
    "status": "verified",
    "verified_at": "2024-01-15T10:35:00Z"
  }
}

Remove Caller ID

Delete a caller ID from your account.

Endpoint

DELETE https://api.audian.com:8443/v2/caller-ids/{caller_id}

Request Example

curl -X DELETE 'https://api.audian.com:8443/v2/caller-ids/cid_abc123' \
  -H 'X-Auth-Token: YOUR_API_KEY'

Caller ID Name Requirements

• Maximum Length: 15 characters
• Allowed Characters: Letters, numbers, spaces
• Special Characters: Limited (no symbols except hyphens)
• Professional: Should represent your business or department

Examples

Good caller ID names:

• "Support"
• "Sales Team"
• "Customer Care"
• "Billing Dept"

Caller ID Number Requirements

• Format: Must be in E.164 format (e.g., "+14155551234")
• Verification: Must be verified before use
• Ownership: Must be a number you own or have rights to use
• Active: Number must be active in your account

Best Practices

1. Use Business Names: Make caller ID identifiable and professional
2. Verify Promptly: Complete verification immediately after adding
3. Remove Unused: Clean up caller IDs you no longer use
4. Test Before Production: Verify recipient sees correct ID
5. Keep It Short: Maximize display on receiving phones
6. Consistency: Use same name across all outbound channels

Limitations

• Maximum Caller IDs: 100 verified caller IDs per account
• Verification Timeout: 24 hours to verify new caller ID
• Verification Attempts: 5 attempts per caller ID
• Country Restrictions: Some countries have additional verification requirements

Compliance

• STIR/SHAKEN: Caller IDs are authenticated via STIR/SHAKEN
• Spoofing Prevention: Numbers must match account ownership
• Regulatory Requirements: Some jurisdictions require attestation
• Robocall Rules: Comply with FCC robocall regulations

Troubleshooting

Issue	Solution
Verification code not received	Request a call instead of SMS
Number shows as unverified	Check your account status
Caller ID not displaying	Verify the name meets requirements
Can't add number	Number may not be eligible

Contact support if you encounter issues with caller ID verification.