Configuration file

Created by Stanislav Timoshenko, last modified by Volodymyr Derba on Dec 08, 2018

Webitel Phone is available for 3 platforms: Windows, Linux and MacOS. The format of the user_config.json configuration file is common to all platforms and will be discussed below.

Order priority

The priority of the search for the application configuration file:

Run the application with the -c or --config switch.
In the user profile directory
In the application directory.

Run-time key

You can specify the path to the configuration file using the key:

webitel-phone -c tmp/user_config.json

or

webitel-phone --config=tmp/user_config.json

User profile directory

The location depends on the operation system.

macOS

At the Finder, press and hold the Option button and click the Go menu - open Library.

Full patch: ~/Library/Application Support/webitel-phone/user_config.json

Linux

Full patch: ~/.config/webitel-phone/user_config.json

Windows

Full patch: %appdata%\webitel-phone\user_config.json

Configuration file

user_config.json

{
	"server": "https://cloud-ua1.webitel.com/engine/",
	"theme": "dark",
	"useWebPhone": true,
	"ringInboundCall": true,
	"notifyNewCall": true,
	"notifyMissedCall": true,
	"usePostProcess": true,
	"alwaysOnTop": true,
	"useDomainAuth": false,
	"domainOAuthServer": "https://adfs.webitel.ua/adfs/oauth2/authorize",
	"domainOAuthResource": "webitel.adfs.identifier",
	"domainOAuthClientId": "webitel.adfs.client_id",
	"domainOAuthDomainName": "tel.bpmonline.com",
	"useHotdesk": false,
	"hotLinks": [
    {
      "name": "kibana dashboard",
      "src": "https://cloud-ua1.webitel.com/kibana/goto/20afb128036d9b8c57d4a447add55bb4?x_key=${KEY}&access_token=${TOKEN}"
    },
    {
      "name": "Наша CRM",
      "src": "https://webitel.bpmonline.com/"
    }
  ]
}

key	Type	Description
server	string	Webitel Engine app server access address
theme	string	Webitel-phone theme
useWebPhone	boolean	includes WebRTC protocol support. If this feature is disabled, a hardware IP phone must be configured
ringInboundCall	boolean	a sound file is playing for an incoming call
notifyNewCall	boolean	additional information is displayed with the ability to manage the incoming call
notifyMissedCall	boolean	displays information about missed calls in a separate pop-up window on a screen
usePostProcess	boolean	displays the post-processing window for outgoing calls
alwaysOnTop	boolean	on top of all windows
useDomainAuth	boolean	will turn on the domain authorization
domainOAuthServer	string	ADFS server access address for domain authorization
domainOAuthResource	string	resource name for domain authorization
domainOAuthClientId	string	application name for domain authorization
domainOAuthDomainName	string	Webitel domain name for domain authorization
useHotdesk	boolean	will turn on HotDesk functionality
hotLinks	multiple data	Array with links for external resources, which will be displayed at Webitel Phone

More information about domain authorization: Login window