Comms Configuration File
From Taridium
| Name | Default Value | Description |
|---|---|---|
| AMIHTTPHost | http://localhost:5039 | the default Asterisk Manager Proxy Host |
| AddLineIAXTemplate | default IAX template to use for additional line softphones in End User Panel, this is deprecated as of 2.3-j | |
| AddLineInstances | 5 | how many softphone additional lines to create when enabling this feature. Additional lines might be created if options like $cfg['enableWRTC'] are enabled |
| AddLineSIPTemplate | Generic SIP NAT | default SIP template to use for additional line softphones in End User Panel, this can be an array |
| AdminForceTOTP | 0 | whether to require two factor authentication on the admin and ITSP panels |
| AdminHeadInclude | include file for Administrator Panel | |
| AdminNoTOTPIP | list of authorized IPs that don't require two factor auth | |
| AnnouncementsDir | /var/lib/asterisk/sounds/announcements | announcement prompts directory |
| AstConfig | /etc/asterisk | asterisk configuration path |
| AstExec | /usr/sbin/asterisk | asterisk binary |
| BSMSClickatellAPIID | Clickatell API ID | |
| BSMSClickatellPassword | Clickatell password | |
| BSMSClickatellUser | Clickatell user | |
| BSMSPanel | 0 | Enable/disable bulk SMS feature in End User Panel (disabled by default) see also $cfg['FeatureList'] with the option 'bsms' to enable this for use |
| BSMSProvider | clickatell | which provider to use: clickatell or twilio |
| BSMSTwilioAccountSID | Twililo Account SID | |
| BSMSTwilioAuthToken | Twilio Auth Token | |
| BSMSTwilioFromDID | Twilio SMS from DID | |
| BrandFollowMe | Follow Me | custom name for follw me |
| BrandName | VoIP | Brand Name |
| BusyRetryWait | 5 | seconds to wait until busy retry dial |
| CDRBrowseOffset | 20 | how may rows should be displayed on the calls page |
| CDRHost | localhost | location of system CDR database |
| CDRMainOffset | 5 | how may rows should be displayed as default on the panel page |
| CDRName | cdr | name of database |
| CDRPass | comms | password |
| CDRSaveIP | 1 | save peer IP address in CDR when call is completed |
| CDRUser | comms | user name |
| CRAlternatePath | 0 | call recording alternate path |
| CRDefaultPath | /var/spool/asterisk/monitor | call recording default path |
| CREnterpriseLimit | 2 | limit of call recording directory size for enterprise in GB |
| CRFormat | gsm | Format for standard call recording (enterprise call recording) |
| CRNotifySupport | 1 | whether to notify customer support when a customer call recording storage facility has reached the set limit. See ['CREnterpriseLimit'] |
| CSSBullet | /images/arrow-right-w.gif | |
| CSSButtonBack | /images/button-bg.gif | |
| CSSButtonBackBack | /images/button-bg-back.gif | |
| CSSButtonBackFwd | /images/button-bg-fwd.gif | |
| CSSLogoutBack | /images/logout-menu-back.gif | |
| CSSLogoutBackActive | /images/logout-menu-back-active.gif | |
| CSSMaster | /css/basic.css | |
| CSSMenuBack | /images/main-menu-back.gif | |
| CSSMenuBackActive | /images/main-menu-back-active.gif | |
| CSSStarImage | /images/asterisk-mini.gif | |
| CSSTableHeadingImage | /images/neat-bg.gif | |
| CSSbordercolor | #CFCFCF | |
| CSSdarkbordercolor | #434343 | |
| CSSdefaultlinkcolor | #767676 | |
| CSSdefaulttablewidth | 650px | |
| CSSfontcolor | #444444 | |
| CSSlinkcolor | #0A699A | |
| CSSmenucolor | #0A699A | |
| CSSsubmenucolor | #24B5FF | |
| CSStablebackground | #F0F0F0 | |
| ChanSpyTimeout | 3600 | Absolute timeout on ChanSpy/Barge functions |
| ConferencingAutoCloseAdmin | 0 | whether to kick all participants once the admin has left the conference room |
| ConferencingMaxCount | 15 | maximum number of conference participants |
| ConferencingMaxEnterprise | 3 | maximum number of conference rooms per enterprise |
| ConnectedLineUpdates | 1 | whether we should send programatical connected line updates (e.g. group call names etc.) |
| ConsoleLinkEUP | 0 | whether to show a link to the Console in the End User Panel |
| CustName | [customer name] | Customer Name |
| CustomerCareEmail | info@example.com | Reply-To E-Mail |
| DBAHost | localhost | location of system database |
| DBAName | comms | name of database |
| DBAPass | commsa | password |
| DBAUser | commsa | user name |
| DBHost | localhost | location of system database |
| DBName | comms | name of database |
| DBNotifyErrors | 1 | Whether to send e-mail notifications to customer care when there is database error |
| DBPass | comms | password |
| DBQueueLog | 0 | whether we should use the DB for qeue logging (also check /etc/asterisk/extconfig.conf) this is the default method as of comms-2.4-d (new installs only) |
| DBUser | comms | user name |
| DIDAssignPilot | 0 | whether to allow pilot/BTN assignments to DIDs (this is only used by pilot2clid.agi) |
| DIDLimitSelection | 8 | limit the choice of suffixes when assigning DID's. |
| DIDPreselectCountry | limit the choice of DID's to a specific country | |
| DIDlockTime | 600 | time in seconds until DID locks expire during signup |
| DateFormat | Y-m-d | standard date format (deprecated, use DefaultDateFormat) |
| DefaultCharset | windows-1252 | default character set |
| DefaultCurrency | $ | default currency |
| DefaultDateFormat | D M d Y | default date format |
| DefaultLanguage | eng | default language (three letter ISO code) |
| DefaultMinimumCallCost | 0.01 | default minimum call cost |
| DefaultTimeFormat | h:i:s A | default time format |
| DeviceAdminPassword | used for device templates %%devadminpw%% | |
| DialExternalTransform | 0 | Example: _NXXNXXXXXX,1\${EXTEN} |
| DialingStripZero | 0 | strip leading zero if any on local calls (enable this for UK etc.) |
| DisallowedUAs | Array | |
| EmailLogo | logo for invoices, if set E-mails will be sent in HTML (see also reseller settings) | |
| EmergencyEmail | emergency access dial notification (if not set the customer care e-mail will be used) | |
| EmergencyNumber | 911 | emergency access number, if not set specifically defaults such as 911, 999, 112 etc. will be matched |
| EntCTIEnabled | 0 | whether to offer CTI callback in groups, extensions etc. |
| EntDIDHelp | ||
| EntDialingHelp | ||
| EntFeatureConferenceHelp | ||
| EntFeatureHolidayHelp | ||
| EntFeatureList | recording,serviceivr,qa,voicemail,did,prompts,moh,toc,conference,timed,holiday,api,dtmfdisplay,callaccounting,ldap,blist | enable enterprise features |
| EntFeatureMOHHelp | ||
| EntFeatureMOHUploadHelp | ||
| EntFeaturePromptsGenerateHelp | ||
| EntFeaturePromptsHelp | ||
| EntFeaturePromptsUploadHelp | ||
| EntFeatureQAHelp | ||
| EntFeatureSIVRHelp | ||
| EntFeatureTimedEditHelp | ||
| EntFeatureTimedHelp | ||
| EntFeatureVoicemailHelp | ||
| EntFeaturesHelp | ||
| EntGroupEditHelp | ||
| EntGroupsHelp | ||
| EntHeadInclude | include file for Enterprise Panel | |
| EntHelpEnabled | 0 | enable this to display help links on the enterprise panel |
| EntIVREditHelp | ||
| EntIVRHelp | ||
| EntLoginInclude | what should appear in the body part of the login page | |
| EnterpriseAdminLoginList | 0 | show enterprises for super user admin (default is FALSE -> security risk!) |
| EnterpriseCCallEnforcement | 0 | whether to enforce enterprise call concurrency |
| EnterpriseDefaultLanding | cdr | default landing when logging into enterprise panel |
| EnterpriseDisallowedExtensions | Array | extension numbers which are not allowed |
| EnterpriseDistinctiveRingHeader | 0 | which header to set on internal calls for distinctive ring, e.g. Bellcore-dr3 |
| EnterpriseEnforceCID | 1 | don't allow CID spoofing on enterprise accounts |
| EnterpriseEnforcePilot | 0 | don't allow arbitrary pilot numbers (need to be a DID) only applies to admin class access |
| EnterpriseExtenLength | 4 | maximum length of enterprise extensions |
| EnterpriseExtenMinLength | 2 | minimum length of enterprise extensions |
| EnterpriseLDAPQuerySource | Enterprise LDAP integration source IP (for display only) | |
| EnterpriseMaxActive | 30 | default maximum number of active extensions per enterprise |
| EnterpriseMaxDID | 30 | maximum number of extensions per enterprise |
| EnterpriseMaxExtensions | 30 | default maximum number of extensions per enterprise |
| EnterprisePilotPattern | 0 | a pattern that a pilot number needs to match to: Perl regular expression |
| EnterpriseRequirePilot | 0 | require a pilot number when creating enterprise, only applies if $cfg['EnterpriseEnforcePilot'] is FALSE |
| ExternalConfServer | 0 | external conference server (always use for multiple servers) |
| FSSwitchPrefix | 0 | whether to prefix all file system directories with the switch ID (applies to VMDefaultPath, MOHDir, PromptsDir and CRDefaultPath) |
| FaxDetectApp | NVFaxDetect | application to detect faxes (needs to support fax extension) |
| FaxDetectAppArgs | dt | fax detection application arguments |
| FaxEmailBody | additional fax body for personal fax2email | |
| FaxFromEmail | no-reply@example.com | from e-mail for fax2email |
| FaxIntercept | 0 | detect and send all faxes to a specific destination |
| FaxReceiveNotifyErrors | 1 | whether to send error messages to the receipient of a fax to e-mail attempt. |
| FeatureList | callforward,vmsettings,callwaiting,addline,assistant,followme,clidblock,intlcalling,callscreen,callrecord,missed,busyretry,emergency,calllist,personalconf | enable enterprise features |
| GlobalDynamicFeatures | global dynamic features are added to all inbound and outbound calls | |
| GlobalPickupDelay | 0 | delay after IVR and feature pickup in seconds |
| GroupDialArguments | Group dial arguments (used in conjunction with StdDialArguments) | |
| GroupPagingEnabled | 0 | group paging (requires conferencing/meetme to work) |
| GroupPagingMaxMembers | 10 | limits the number of paging members in a group |
| GroupPagingNoAAUserAgents | Array | array of user agent match strings which should not be sent an auto-answer header |
| HTTPGroup | apache | default HTTP server group |
| HTTPUser | apache | default HTTP server user |
| IPSBlockIntlOnly | 0 | only drop international calls |
| IPSBlockedUA | 0 | array of banned UAs |
| IPSIgnoreIPPPChange | 0 | whether to ignore changes of IP when the UA remains the same, even when changing from private to public |
| IPSTracking | 0 | intrusion detection and prevention |
| ITSPAllowEnterpriseEdit | 1 | |
| ITSPHeadInclude | include file for ITSP interface | |
| ITSPLoginInclude | what should appear in the body part of the login page | |
| IntBlockPattern | 011. | sets the pattern for international call blocking / see also $cfgdef['IntlPrefix'] |
| IntlAutoBlockCheckPeriod | 0 | how often to check for international call levels (in seconds) - set to 0 for disabled |
| IntlAutoBlockRatingTable | 0 | which rating table to use for automatic blocking |
| IntlAutoBlockThresholdSelect | Array | at what level we want to auto block international calling |
| IntlBlockDefault | 0 | whether to create new enterprises with international calling blocked by default |
| IntlBlockList | a supplemental list of prefixes which are considered 'international' e.g. NANP list, can be a web resource | |
| IntlExclusionPattern | ^\+[2-9] | the + style pattern which should be always considered international |
| IntlFraudMultiplier | 1 | by how much we should multiply sales rates when checking for international fraud |
| IntlPrefix | 011 | prefix for international calls / see also $cfgdef['IntBlockPattern'] |
| IntlReportActivity | 0 | whether a report e-mail should be sent out regardless of threshold settings (see $cfg['IntlAutoBlockCheckPeriod']) |
| IntlReportActivityAlways | 0 | whether to send the report regardless of whether there have been any calls |
| LocalDialLength | 7 | local dial string length |
| LogTransactions | 0 | whether to log transaction (default is off) |
| MOHDir | /var/lib/asterisk/mohmp3 | Music On Hold Directory |
| MOHDirDefault | /var/lib/asterisk/mohmp3/template-default | Source of default MOH files |
| MOHFormat | .mp3 | music on hold upload format |
| MOHMaxfilesize | 16 | maximum upload file size in MB |
| MOHNative | 1 | use native slinear on-board storage |
| MOHRandom | 1 | whether to play music on hold files randomly |
| MarketingURL | http://www.taridium.com | Marketing URL |
| MeetMeExitContext | inconf | where to exit to when a keypress is received in a conference call |
| MemCachedHost | localhost | Your Memcached Server |
| MemCachedPort | 11211 | Your Memcached Server |
| MinCallDuration | 30 | minimum call duration required for call credits |
| MobileUserAgents | iPhone,telx,mobi,BlackBerry,Windows CE,Android,HTC_,Symbian,Palm | preset mobile user agents |
| NoSanitizedCLIDName | 0 | whether to disable caller ID sanitization on inbound calls |
| NotifyEMail | 1 | Additional E-Mail notification interface (TRUE/FALSE) |
| NotifyFromEmail | demo@example.com | from e-mail address on notifications only |
| NotifyPhone | 1 | Additional Phone notification interface (TRUE/FALSE) |
| NotifyReplyEmail | demo@example.com | reply to e-mail address on notifications only |
| NotifySMS | 0 | SMS notification interface (TRUE/FALSE) |
| OneTouchMaxMessage | 100 | limits how many message one-touch recordings can store in VM folder (should be bigger or equal than maxmessage in voicemail.conf) |
| PDFInvoiceDir | /var/spool/comms/invoices | where to store PDF invoices |
| PDFInvoicePageSize | Letter | Page size for PDF generation |
| PWminlength | 6 | min. length of signup/end user panel password |
| PanelAccountBillingHelp | ||
| PanelAccountEditHelp | ||
| PanelAccountOverviewHelp | ||
| PanelAddVirtualDIDHelp | ||
| PanelCallingTech | Array | |
| PanelEmergencyHelp | ||
| PanelFeatureBusyRetryHelp | ||
| PanelFeatureCLIDBlockHelp | ||
| PanelFeatureCallRecordingHelp | ||
| PanelFeatureCallScreenHelp | ||
| PanelFeatureCallWaitingHelp | ||
| PanelFeatureFollowmeHelp | ||
| PanelFeatureForwardHelp | ||
| PanelFeatureIntlCallingHelp | ||
| PanelFeatureMissedCallsHelp | ||
| PanelFeaturesHelp | ||
| PanelHeadInclude | include file for End-User Panel | |
| PanelHelpCalls | ||
| PanelHelpEnabled | 0 | enable this to display help links on the end-user panel |
| PanelHelpVoicemail | ||
| PanelLoginInclude | what should appear in the body part of the login page | |
| PanelManageVirtualDIDHelp | ||
| PanelNetavailHelp | ||
| PanelRemoveVirtualDIDHelp | ||
| PanelVMCopyEnabled | 1 | |
| ParkingApp | 0 | support for call parking |
| ParkingTimeout | 180 | how long until hangup of a parked call in seconds |
| PermissionControl | 0 | whether to enable permission control table editor |
| PersonalConfLimit | 5 | maximum number of personal conference room participants |
| PhoneNoPattern | X-XXX-XXX-XXXX | |
| PortNumber | 1 | allow number porting |
| PostCreateEnterprise | 0 | Script to run after enterprise is created |
| PostEditEnterprise | 0 | Script to run after enterprise is edited |
| PromptRecordingTimeout | 30000 | maximum recording time for prompts in ms |
| PromptsDir | /var/lib/asterisk/sounds/prompts | system prompts directory |
| PromptsFormat | .gsm | voice prompts upload/default format (wave files are always accepted) |
| PromptsMaxfilesize | 16 | maximum upload file size in MB |
| PromptsNative | 1 | use native slinear on-board storage |
| ProvisioningServer | used for device templates %%provserver%% | |
| QAFromEmail | info@taridium.com | Q&A from e-mail address |
| QARecordingFormat | .wav | recording format (.wav or .gsm) |
| QAReplyEmail | info@taridium.com | Q&A reply to e-mail address |
| QueueDialArguments | x | queue dial arguments |
| RACallsTable | 0 | a table which rates accounted calls |
| RECHost | localhost | location of system recording database |
| RECName | monitor | name of database |
| RECPass | comms | password |
| RECUser | comms | user name |
| RatingDisabled | 0 | disable call rating |
| SIPApplicationServer | 0 | optional server IP address to send IVR functions to |
| SIPProxy | SIP proxy to use | |
| SIPProxyLocal | 0 | whether to use local SIP proxy - cannot be used with SIPProxy value |
| SIPProxyPort | 5060 | do not change here |
| SIPTrunkCallLimit | 25 | default number of concurrent SIP trunk calls |
| SIPTrunkCodecOrder | ulaw,alaw,g729 | what SIP codecs to offer as default |
| SIPTrunkSendRPID | yes | whether to send RPID on SIP trunk calls |
| SIPTrunkTrustRPID | yes | whether to trust RPID on SIP trunk calls |
| SIPiclimit | 2 | limit incoming calls on SIP channels (call waiting) |
| SIPoglimit | 2 | limit outgoing calls on SIP channels |
| ServerFromEmail | info@example.com | From address of e-mails |
| ServiceDemo | 0 | enables 'demo' mode for /signup-ent/ |
| ServiceDemoPlanID | 0 | which plan ID to use (numeric ID) when running signups in demo mode (ServiceDemo=TRUE) |
| ServiceHeadImage | /images/taridium-logo-large.png | The Logo for /service/ 180x58px |
| ServiceIVRModeOnStarVM | vm | What to present when the caller presses * on listening to a voicemail greeting (vm,disa,full or disabled) |
| SessionTimeout | 1200 | seconds until the login sessions time out |
| ShortcutIcon | /images/taridium.ico | |
| SignupEntEmailFooter | Your Suppport Team at Taridium
http://taridium.com US: +1 800 801 0039 Canada: +1 289 288 3617 Europe: +41 44 786 70 11 | |
| SignupEntHeadImage | /images/taridium-logo-large.svg | The Logo for /signup-ent/ 180x58px |
| SignupFooterInclude | include file for Signup Forms (m=[signup step] is passed along) | |
| SimulateSignup | 1 | simulate CC signup? default install is 1 (YES) |
| SiteName | taridium | Site Name |
| SiteURL | http://www.taridium.com | Site Name |
| SoftwareClient | Array | 200 x 150px |
| SpoolAttempts | 4 | how many call attempts |
| SpoolDuration | 25000 | how long to try on outbound/spooled calls in ms |
| SpoolEscalationTimeout | 600 | how long to wait until trying next number (if applicable) should be >= than SpoolAttempts x SpoolInterval |
| SpoolInterval | 150 | how long to wait between spooled calls in s |
| StdDialArguments | tr | standard dial arguments |
| StripCIDCountryCode | 0 | remove caller ID country code (e.g. US 10 digits for outgoing caller ID) |
| StripCIDPlusInbound | 0 | whether to strip + sign on inbound caller ID's (e.g. e.164 CID) |
| StripIntlPrefix | 0 | strip intl. prefix on all outbound calls |
| SwitchID | 0 | only needed in multiswitch environments (e.g. sw5) |
| SystemName | pbx-management | System Name (can be anything) |
| SystemPromptsDir | /var/lib/asterisk/sounds | system prompts directory |
| TTSAcapelaApp | Acapela application | |
| TTSAcapelaLogin | Acapela Login | |
| TTSAcapelaPwd | Acapela Password | |
| TTSAcapelaURL | https://vaas.acapela-group.com/Services/Synthesizer | Acapela Request URL |
| TTSAcapelaVoices | Array | the Acapela voices to offer/use |
| TTSCepstralGen | /usr/local/bin/swift | location of Cepstral Swift |
| TTSEngine | festival | options are: swift, festival or acapela (cloud API) |
| TTSFestivalGen | /usr/bin/text2wave | location of Festival text2wave |
| TableOffSet | 20 | default table offset |
| TemplateReplaceListIAX | name,username,secret,callerid,accountcode,mailbox | variables for template |
| TemplateReplaceListSIP | name,username,secret,callerid,nat,accountcode,mailbox | variables for template |
| TimeFormat | H:i:s | standard time format (deprecated, use DefaultTimeFormat) |
| TransactionLogMaxAge | 1209600 | whether to automatically delete the transaction log entries beyond a certain age in seconds |
| TrunkDialArguments | tTWX | standard dial arguments |
| UNminlength | 6 | min. length of signup username |
| UpNextMax | 10 | Maximum times the up next (upon timeout) function can be called to prevent loops |
| UploadDir | /var/www/upload | where uploaded files go |
| UseConfBridge | 0 | Whether to use the alternative conferencing application (overriden by $cfg['ExternalConfServer']) |
| VMAccessSkipPW | 0 | when this is enabled auto-login will not only skip the box no. but also PIN. |
| VMBroadcastNative | 0 | use asterisk to record and distribute voicemail broadcasts |
| VMClickatellAPIID | Clickatell API ID, see $cfgdef['NotifySMS'] | |
| VMClickatellPassword | Clickatell password, see $cfgdef['NotifySMS'] | |
| VMClickatellUser | Clickatell user, see $cfgdef['NotifySMS'] | |
| VMContext | customers | VM default context |
| VMCustomBody | Dear ${VM_NAME}:
just wanted to let you know you were just left a ${VM_DUR} long message (number ${VM_MSGNUM}) in mailbox ${VM_MAILBOX} from ${VM_CIDNUM} - ${VM_CIDNAME}, on ${VM_DATE}, so you might want to check it when you get a chance. Thanks! --comms, hosted business telephone systems by Taridium | |
| VMCustomEMail | 0 | enables/disables custom e-mail settings in resellers etc. |
| VMCustomFromEmail | 0 | A custom value for the from address when sending e-mails (this will be overwritten when a reseller is set. Format: "Voicemail" |
| VMCustomSubject | [comms] New voicemail in mailbox ${VM_MAILBOX} from ${VM_CALLERID} | |
| VMDefaultPath | /var/spool/asterisk/voicemail | VM default path |
| VMFormat | .wav | voicemail storage format, this must match one of the formats in voicemail.conf |
| VMFullWarning | 1 | whether to notify mailbox users via e-mail when the mailbox is full |
| VMMaxEnterpriseMessages | 200 | maximum value for enterprise voicemail settings |
| VMNexiwavePassword | Nexiwave account password | |
| VMNexiwaveUser | Nexiwave account user | |
| VMPINLengthMin | 4 | minimum length for voicemail PINs (limited to 8 digits) |
| VMSMSProvider | clickatell | which provider to use: clickatell or twilio |
| VMSpeech2Text | 0 | enables/disables voicemail speech to text engines (requires VMCustomEMail = TRUE) |
| VMTwilioAccountSID | Twililo Account SID | |
| VMTwilioAuthToken | Twilio Auth Token | |
| VMTwilioFromDID | Twilio SMS from DID | |
| ValidateCC | 0 | validate credit cards |
| WebRTC_Template | template to use for WebRTC client | |
| WebRTC_bandwidth | ||
| WebRTC_enable_early_ims | false | |
| WebRTC_enable_media_stream_cache | true | |
| WebRTC_enable_rtcweb_breaker | false | |
| WebRTC_ice_servers | [{ url: 'stun:null'}] | |
| WebRTC_video_size | ||
| accountNotActivePrompt | suspended | what to play back if the account has been suspended prompts/comms directory |
| accountNotFoundPrompt | suspended | what to play back if the account has not been found prompts/comms directory |
| commsPromptsDir | /var/lib/asterisk/sounds/comms | application prompts directory |
| incomingContext | incoming | incoming context |
| incomingDIDPrefix | prefix to add to incoming numbers for matching. System expects full e614 no.s | |
| insideContext | inside | local context |
| keepChannelPasssword | 0 | whether to keep the password on channel updates or renew |
| lookupLocally | 1 | lookup outgoing DID's locally |
| outgoingContext | outgoing | outgoing context |
| outgoingContextFax | 0 | alternate outgoing context for faxes (see mail2fax) |
