The following functions are only available to the root customer user.
The application supports trusted mode and i_customer parameter should be supplied in this case.
These functions work with the system_config* tables only and do not affect the system table.
getSystemConfig()
Retrieve configuration. Returns all known keys and their current values.
Parameters:
- key - Result should be returned for this key only. String. Optional.
Returns:
- config - list of configuration records where each record contains the following fields:
- key - String
- current_value - String
- default_value - String
setSystemConfig()
Set a configuration value.
Parameters:
- key - The key name. Only values which are present in the system_config_defaults table are allowed. String.
- value - The value. String.
Returns nothing
_____________________________________________________________________________________________________________________________________
Available configuration options
The options available on a particular system depend on its software release. Use getSystemConfig() without a key to retrieve the authoritative list for that system.
| Option name | Description |
|---|---|
billing/low_balance/autocharge/retry_interval | Number of seconds before another attempt is made to charge a debit or credit card after a failed automatic charge. |
billing/low_balance/notification/default_retry_count | Default number of repeat low-balance notifications when no account-specific value is configured. |
billing/low_balance/notification/default_retry_interval | Default interval, in hours, between repeat low-balance notifications. |
billing/low_balance/notification/max_retry_count | Maximum allowed number of repeat low-balance notifications. |
billing/media_timeout_correction | Number of seconds deducted from billed duration when a call is disconnected because media is absent. |
chm_checkerd/sip/udp_port | Local UDP port used by the chm_checkerd daemon. |
cloudbackup/access_key_id | AWS S3 access key ID used to export backups. |
cloudbackup/enabled | Enables or disables exporting backups to an AWS S3 bucket. |
cloudbackup/limit_bw | Bandwidth limit for uploading backups to AWS S3. |
cloudbackup/secret_access_key | AWS S3 secret access key used to export backups. |
data_retention/invoices/purge_in | Number of months to retain invoices before purging them. |
ivr/freshdesk/api_key | Freshdesk API key used by the Freshdesk IVR application. |
ivr/freshdesk/passwd | Password for the Freshdesk user used by the Freshdesk IVR application. |
ivr/freshdesk/ssp_support_cld | Destination number to which a call is forwarded after the Freshdesk IVR application phase is complete. |
ivr/freshdesk/username | Username used to access the Freshdesk API from the Freshdesk IVR application. |
lrn/cache/enabled | Enables or disables caching of data received from the LRN provider. |
lrn/cache/timeout | Local LRN cache lifetime, in seconds. |
lrn/failure/notification/threshold | Combined number of LRN lookup failures required before an LRN failure notification is generated. |
lrn/request/timeout | Number of seconds to wait for a reply from an LRN provider before routing the call further. |
lrn/server/next/timeout | Number of seconds to wait before sending the INVITE to the next server in the LRN server list. |
mfa/enabled | Enables or disables multifactor authentication by email. |
mfa/type/ga/enabled | Enables or disables multifactor authentication using Google Authenticator. |
mfa/type/token/expiration | Email MFA token lifetime, in seconds. |
mfa/validation_period | Number of days after which a web user must pass email MFA validation again. |
software/end_of_support_date | End-of-support date used when displaying notifications to web users. |
software/release_date | Major release date used when displaying software update notifications to web users. |
software/update_date | Date of the last software update used when displaying notifications to web users. |
system/backup/notifications/onsuccess | Controls whether the switch owner receives an email notification after a successful backup in any environment. |
system/balances_db_created | Internal flag indicating whether the balances database has been created. Do not change unless instructed by Sippy Support. |
system/cdrs/account/extended_info/enabled | Controls whether account call-authentication details are written to cdrs_ext_info. |
system/cdrs/export/thrift/enabled | Enables or disables generation of Thrift export files by sqlcached. |
system/dids/account/skip_insecure_auth_rules | When enabled, DIDs with insecure authentication rules, such as rules without a vendor or connection, are ignored during call authentication. This does not affect IVR calls or late DID recognition. |
system/monitoring/notifications/enable | Comma-separated set of system monitoring notifications enabled system-wide or per environment. Supported values are reported in value_type. |
system/profiling/enabled | Enables or disables additional Go profiling diagnostics for an environment. |
system/rfc3262/mode/outgoing | Controls reliable provisional response support for outgoing calls. require sends Require: 100rel, supported sends Supported: 100rel, and off disables the feature. |
system/security/alert/open_db_firewall | Displays a web UI security alert when the default database firewall policy is Allow. |
system/security/alert/open_sip_firewall | Displays a web UI security alert when the default SIP firewall policy is Allow. |
system/security/alert/open_ssh_firewall | Displays a web UI security alert when the default SSH firewall policy is Allow. |
system/security/alert/open_tftp_firewall | Displays a web UI security alert when the default TFTP firewall policy is Allow. |
system/security/alert/open_web_firewall | Displays a web UI security alert when the default web firewall policy is Allow. |
system/service_code/followme/mode | Default mode for Follow Me entries created through the Service Code IVR. |
system/service_code/followme/timeout | Default timeout, in seconds, for Follow Me entries created through the Service Code IVR. |
system/sip/2xx_starts_on_setup | Controls when the final 2xx response timeout begins. When disabled, the timeout starts after the first provisional 1xx response. |
system/sip/authentication/attr_order | Controls the order of attributes used to authenticate incoming SIP traffic. |
system/sip/default_media_relay | Default media relay assigned when new Connections or Routing Groups are created. |
system/sip/headers/cisco-guid/generate | When enabled, generates new Cisco-GUID and H323-Conf-ID headers if they are absent from the incoming call leg. |
system/sip/headers/cisco-guid/pass | When enabled, copies the Cisco-GUID header from the incoming call leg to the outgoing call leg. |
system/sip/headers/passthrough | Comma-separated list of SIP headers passed from account to vendor without modification. Header names are case-insensitive. |
system/sip/headers/record | Comma-separated list of SIP headers recorded from the caller's initial INVITE and from final vendor responses in the corresponding SIP header CDR tables. |
system/sip/headers/sip_contact/display_name/anonymous | When enabled, uses Anonymous as the display name in the Contact URI of outgoing INVITEs. When disabled, uses the caller name from the From URI. |
system/sip/hep_tracing/collector | Remote HEP collector address and parameters, for example 178.62.220.215:9060;version=2;transport=udp. |
system/sip/hep_tracing/enabled | Enables or disables exporting OpenSIPS SIP logs to a remote server using HEP. |
system/sip/hep_tracing/local_port | Local TCP and UDP port on which the OpenSIPS HEP module listens. The port must not be used by another service. |
system/sip/outgoing/ruri/add_lrn | When enabled, adds the npdi parameter to the user part of the outgoing INVITE Request-URI after an LRN lookup, and adds rn when it was returned by the LRN provider. |
system/sip/privacy/mode | Controls how P-Asserted-Identity information is considered during call authentication. |
system/sip/privacy/trusted_domain/onnet | Controls whether Privacy and P-Asserted-Identity headers are sent for on-net calls when account privacy headers are trusted. |
system/sip/stir_shaken/auth/1callconnect/sip_host | SIP host used by the 1CallConnect STIR/SHAKEN authentication connector. |
system/sip/stir_shaken/auth/1callconnect/uuid | UUID used by the 1CallConnect STIR/SHAKEN authentication connector. |
system/sip/stir_shaken/auth/connector | Selects the connector used for STIR/SHAKEN authentication. |
system/sip/stir_shaken/auth/local_db/attest | Default attestation level used by the local-database STIR/SHAKEN authentication connector. |
system/sip/stir_shaken/auth/local_db/crt/url | Public certificate URL included in STIR/SHAKEN Identity headers when local-database authentication is used. |
system/sip/stir_shaken/auth/local_db/crt_idx | Index of the SSL certificate used by the local-database STIR/SHAKEN authentication connector. |
system/sip/stir_shaken/auth/local_db/origid | Origin identifier used by the local-database STIR/SHAKEN authentication connector. |
system/sip/stir_shaken/auth/sip_redirect/host | SIP redirect host used for STIR/SHAKEN authentication. |
system/sip/stir_shaken/verify/connector | Selects the connector used for STIR/SHAKEN verification. |
system/sip/stir_shaken/verify/local_db/root_ca_list_idx | Index of the root CA list used by the local-database STIR/SHAKEN verification connector. |
system/sip/stir_shaken/verify/mode | Selects strict or relaxed STIR/SHAKEN verification mode. |
system/sip/stir_shaken/verify/sip_redirect/host | SIP redirect host used for STIR/SHAKEN verification. |
system/sip/tcp/connect_timeout | TCP connection timeout for SIP calls, in milliseconds. |
system/sip/tcp/connection_lifetime | Lifetime, in seconds, for inactive SIP TCP sessions before OpenSIPS closes them. |
system/sip/tcp/max_msg_time | Maximum number of seconds allowed for a complete SIP message to arrive over TCP before the connection is dropped. |
system/sip/tls/handshake_timeout | TLS handshake timeout for SIP calls, in milliseconds. |
system/sip/tls/send_timeout | TLS send timeout for SIP calls, in milliseconds. |
system/sip_frontend | Selects the SIP registrar and stateless proxy implementation available in the installed release. |
system/strackerd/next_duration_algorithm | Algorithm used to calculate the allowed call duration from the available balance and remaining minutes. |
system/tariffs/default_decimal_precision | Default cost decimal precision assigned when a new Tariff is created. |
system/vendors/default_decimal_precision | Default cost decimal precision assigned when a new Vendor is created. |
system/web/nginx/cgi_timeout | Shared nginx request timeout, in seconds, for PHP FastCGI and XMLAPI uWSGI handlers. |
webui/disable_ssl_warning | Disables web UI warnings for an expired or unconfigured SSL certificate. Use only when instructed by Sippy Support, because certificate problems will no longer be shown. |
webui/pages_with_php_debug_enabled | Comma-separated list of web UI pages for which page-scoped PHP debugging is enabled. Use only for diagnostics as instructed by Sippy Support. |
webui/readiness_for_upgrade/enabled | Shows or hides the Readiness for Upgrade section on the System Information page. |
webui/reports/cdrs/rows_limit | Maximum number of rows returned in CDR reports. |
webui/vendor_connections/hide_password | Controls whether Vendor Connection passwords are hidden in the web UI. |