Settings

PBX-wide configuration for business hours, recording, and dialing

PBX settings control system-wide defaults for your phone system. Individual extensions can override some settings.

Get Settings

GET/v1/pbx/settings

Get PBX configuration

Requires:pbx:settings:read

curl -X GET "https://api.do.dev/v1/pbx/settings" \
  -H "Authorization: Bearer do_live_your_key_here"

{
  "settings": {
    "timezone": "America/New_York",
    "businessHoursStart": "09:00",
    "businessHoursEnd": "17:00",
    "businessDays": [1, 2, 3, 4, 5],
    "extensionLength": 3,
    "defaultCallerIdName": "Acme Corp",
    "defaultCallerIdNumber": "2395551234",
    "recordingMode": "always",
    "recordingScope": "external",
    "internationalDialing": false,
    "emergencyNumber": "911",
    "holdMusicId": "music_default",
    "voicemailRetentionDays": 90,
    "recordingRetentionDays": 90
  }
}

Configuration Options

Settings

timezonestring

IANA timezone (e.g., 'America/New_York'). Used for business hours and time-based routing.

businessHoursStartstring

Business hours start time (HH:MM, 24hr)

businessHoursEndstring

Business hours end time (HH:MM, 24hr)

businessDaysnumber[]

Business days (0=Sunday, 6=Saturday)

extensionLengthnumber

Default extension number length (3-5 digits)

defaultCallerIdNamestring

Default outbound caller ID name

defaultCallerIdNumberstring

Default outbound caller ID number

recordingModestring

Default recording mode: none, always, on_demand

recordingScopestring

Recording scope: all, external, inbound

internationalDialingboolean

Allow international outbound calls

holdMusicIdstring

Default hold music track ID

voicemailRetentionDaysnumber

Days to retain voicemail messages

recordingRetentionDaysnumber

Days to retain call recordings