entity defined as "network" type in res_digium_phone.conf.
Assigns a network profile to a phone. More than one network can be assigned to a phone by using multiple network lines
entity defined as "firmware" type in res_digium_phone.conf
Assigns a firmware to a phone. More than one firmware can be assigned to a phone, provided that each firmware is for a different model, by using multiple firmware lines
A MAC address, e.g. 0123456789ab
Optional. When set, and when the general config_auth option requires MAC, locks a phone configuration to a device matching this MAC address.
integer, e.g. 10101019; or "voicemail"
Optional. When set, and when the general config_auth option requires PIN, one must enter this PIN on the phone before being able to pull the phone's configuration. If set to "voicemail" will tie the phone's pin to the voicemail account password, from voicemail.conf, as defined for the SIP peer, for flat-file configurations without externally maintained passwords only, used for the phone's primary internal line.
integer; e.g. 101010109
Optional. When set, and when the general config_auth and userlist_auth options are set to globalpin, assigns this phone a group pin. When the group pin is input by the user, all phones with a matching group_pin will appear in the list of available phone profiles
entity defined as line in res_digium_phone.conf
Maps directly to a PJSIP endpoint entry. More than one line may be defined for a phone configuration. The first line entry defined is adopted as the phone's primary line.
entity defined as external_line in res_digium_phone.conf
Maps directly to an external_line defined in this configuration file. External line are lines not defined by SIP peers in sip.conf and generally do not register to this instance of Asterisk. If an external line is defined as the primary extension for a phone, many of the advanced phone application features will be disabled
Application section name identifier
Applies application-specific settings to a phone configuration. Multiple application options can exist in a single phone configuration
file, e.g. mycustomconfig.xml
The phone module automatically generates a configuration file for each phone based on the lines assigned to it; but, it is possible to supply a custom configuration file instead. Using this option will direct the DPMA to serve up the specified file, as found in the file_directory defined directory, to the phone. Note that using a custom configuration file, as opposed to the provisioning generated by the DPMA, precludes the phone's use of DPMA-specific applications, e.g. voicemail, parking, user status, etc. This option allows users to make use of the DPMA's mDNS provisioning capabilities, providing a simpler alternative to HTTP and Option 66 provisioning, but sacrifices the DPMA-specific features.
string, e.g. Bob Johnson
The full name of the person who will be using this phone, and what will appear in the user list that the phone pulls
file, e.g. contacts.xml
An XML file, retrievable from the file_url_prefix, containing a list of contacts to serve to the phone. Multiple contact options can exist in a single phone configuration.
|contacts_display_rules||file, e.g. mydisplayrules.xml||An XML file in the file_directory containing rules that control the display of actions when viewing a contact.|
string, a group from contacts
Every contacts xml file will have at least one group defined in it. This setting controls which loaded group the phone should subscribe to for its Rapid Dial (BLF) keys.
|blf_items||file e.g. blfitems.xml||An XML file, retrievable from the file_url_prefix, containing a list of items to be displayed on the phone's BLF keys. Only one blf_items option can exist in a single phone configuration. This option should note be used with phones possessing firmware older than 1.4, otherwise phones will end up in a boot loop.|
|blf_page_return_timeout||integer, time in seconds||An integer value representing the number of seconds until BLF page retrieval times out. Upon reaching the specified timeout the first page of BLF pages is shown. Defaults to 0 (never).|
|integer, e.g. 40||Sets the maximum number of SUBSCRIBEs a phone can perform; defaults to 40|
Timezone String, e.g. America/Chicago
Sets the timezone used for the clock on this phone.
seconds as integer, e.g. 86400
Defines the interval between NTP synchronization
extension, e.g. 700
Sets the extension used for parking calls. When this option is set, and the phone has an in-progress call, it will display a "Park" softkey, allowing for one touch parking.
blind / attended
The type of transfer to perform when parking a call using the "Park" softkey.
|show_call_parking||yes / no||Enables the built-in call parking application. When disabled, the one touch call parking softly is shown, if parking_exten is set, but the Parking Lot notice screen nor the Parking Lot applications are available from the phone's application menu.|
context name of a type=ringtone identifier
Loads ringtones onto a phone. More than one ringtone may be loaded onto a phone.
Alarm, Chimes, Digium, GuitarStrum, Jingle, Office2, Office, RotaryPhone, SteelDrum, Techno, Theme, Tweedle, Twinkle, Vibe or the context name of a type=ringtone identifier that has been loaded onto the phone using the ringtone option
Sets the active ringtone for the phone, defaults to Digium.
no / yes
By default, when using the Digium Phone Module for Asterisk, the phone's built-in Web UI is disabled. To override this and enable the Web UI anyway, which may result in unpredictable behavior if user settings conflict with the settings provided by the DPMA, enable this option.
no / yes
When this option is enabled, and the phone has an in-progress call, it will display a "Record" softkey, allowing for one touch call recording. Disabled by default.
|can_forward_calls||yes / no||When this option is disabled, the phone will not display the Call Forward application in the applications menu. Supported beginning with phone firmware 1.4.1|
|show_call_log||yes / no||When this option is disabled, the phone will not display the Call Log application in the applications menu or the associated soft key on the idle screen. Supported beginning with phone firmware 1.4.1.|
Alert section name identifier
Defines Alerts to be applied to this phone profile. More than one Alert may be applied by specifying additional alert lines.
|multicastpage||Mutlicastpage section name identifier||Defines Multicastpage listeners to be applied to this phone profile. More than one Multicastpage listener may be applied by specifying additional multicastpage lines.|
no / yes
Digium phones, by default, place BLF keys on the sidecar, not on unused line keys. To disable this behavior and allow BLF keys to start mapping from the next available unused line key, enable this option.
yes / no
Disabling this option hides the "Send VM" softkey during incoming calls and the "Transfer VM" softkey inside the Contacts application during call transfers. Enabled by default.
The idle screen image for a D40 model phone in PNG format, 150x45 pixels, 8-bit depth, a color type without alpha transparency and less than 10k in size. Retrieved from the file_url_prefix. The D40, D45 and D50 screen size is the same; therefore it is permissible to re-use the same logo file for each.
|d45_logo_file||string||The idle screen image for a D45 model phone in PNG format, 150x45 pixels, 8-bit depth, a color type without alpha transparency and less than 10k in size. Retrieved from the file_url_prefix. The D40, D45 and D50 screen size is the same; therefore, it is permissible to re-use the same logo file for each.|
The idle screen image for a D50 model phone in PNG format, 150x45 pixels, 8-bit depth, a color type without alpha transparency and less than 10k in size. Retrieved from the file_url_prefix. The D40, D45 and D50 screen size is the same; therefore it is permissible to re-use the same logo file for each.
|d60_logo_file||string||The idle screen image for a D60 model phone in PNG format, 205x85 pixels, 8-bit depth, a color type without alpha transparency and less than 10k in size. Retrieved from the file_url_prefix.|
|d62_logo_file||string||The idle screen image for a D62 model phone in PNG format, 205x85 pixels, 8-bit depth, a color type without alpha transparency and less than 10k in size. Retrieved from the file_url_prefix.|
|d65_logo_file||string||The idle screen image for a D65 model phone in PNG format, 205x85 pixels, 8-bit depth, a color type without alpha transparency and less than 10k in size. Retrieved from the file_url_prefix.|
The idle screen image for a D70 model phone in PNG format, 205x85 pixels, 8-bit depth, a color type without alpha transparency and less than 10k in size. Retrieved from the file_url_prefix.
|d80_logo_file||string||The idle screen image for a D80 model phone in PNG format, 800x1280 pixels. Retrieved from the file_url_prefix.|
|wallpaper_file||string||The wallpaper image for a D6x model phone in PNG format, 480x272 pixels, 8-bit depth, a color type without alpha transparency and less than 50k in size. Retrieved from the file_url_prefix.|
auto, plantronics, jabra_iq
Sets the electronic hookswitch device type.
yes / no
Enabling this option locks phone preference settings to the DPMA supplied settings. Enabling this option also hides phone preference menus for menu items that are set in the Phone profile. Disabled by default
Integer, e.g. 789
Sets the Admin Password for logging into Web UI or Admin Settings Section on Phone Menu, defaults to 789
Sets whether to accept calls from any source or only from hosts to which the phone is registered
yes / no
Enables / Disables display of missed calls on the phone, defaults to Enabled
|idle_company_text||String||When set, allows control over the text string seen on idle screens in the status bar. D6x phones only, beginning with firmware 18.104.22.168. Defaults to null.|
|small_clock||yes / no||Enables / Disables display of the small-format clock on a D6x phone's idle screen. Defaults to disabled (show large clock).|
|default_fontsize||integer, e.g. 10||Sets the default font size for the phone. Caution should be exercised when using this option as larger sizes will cause labels to overrun their allowed space. D40, D45 and D50 default to 10. D70 defaults to 11.|
Sets the LCD screen brightness, defaults to 5
Sets the LCD screen contrast, defaults to 5
Enable backlight dimming. When enabled, dims the screen after backlight timeout has been reached and phone is otherwise idle. Defaults to enabled
Time, in seconds, before backlight is set to backlight_dim_level while phone is idle; setting to 0 disables backlight timeout, defaults to 0
Brightness level dims to when when dim_backlight is enabled, defaults to 2.
de_DE, en_AU, en_CA, en_GB, en_NZ, en_US, es_ES, es_MX, fr_BE, fr_CA, fr_FR, it_IT, nl_BE, nl_NL, pt_BR, pt_PT, ru_RU
Specifies the locale used by the phone, defaults to en_US. ru_RU applies only to D6x models of phones.
Sets the ringer volume, defaults to 5
Sets the speaker volume, defaults to 5
Sets the handset volume, defaults to 5
Sets the headset volume, defaults to 5
|call_waiting_tone||yes / no||If disabled, the phone will not play a call waiting tone when it receives a new call while already on a call.|
|handset_sidetone_db||Integer, e.g. -25|
Sets the gain, in negative dBs, for sidetone presented on the phone's handset. Defaults to -25. Digium cautions against changing this value.
|headset_sidetone_db||Integer, e.g. -15||Sets the gain, in negative dBs, for sidetone presented on the phone's headset. Defaults to -15. Digium cautions against changing this value.|
yes / no
If enabled, volume changes made during a call do not persist to the next call, defaults to disabled
yes / no
Sets whether to use the headset, rather than the speaker, for answering all calls, defaults to disabled
|ring_headset_only||yes / no||Sets whether or not to play ringing tone out the headset, instead of the loudspeaker. Note that adjusting the ringing volume while ringing is playing out the headset port will cause ringing tone to play out the loudspeaker.|
Formats the display of contact names, defaults to first_last
|lan_port_mode||auto, 10hd, 10fd, 100hd, 100fd, 1000fd||Sets the port speed of the phones' LAN port. Available options depend on phone model. Defaults to auto|
|pc_port_mode||auto, 10hd, 10fd, 100hd, 100fd, 1000fd, off||Sets the port speed of the phones' PC port. Available options depend on phone model. When set to off, the PC port will be disabled. Defaults to auto|
|enable_check_sync||yes / no||Defaults to yes. If disabled, phones will not respond to check-sync SIP Events.|
|8021x_passthrough||yes / no||Defaults to no. If enabled, phone will allow EAPOL packets to cross from PC port to LAN port.|
|8021x_eapol_on_disconnect||yes / no||Defaults to no. If enabled, phone will keep track of EAPOL logins from PC-port attached devices and send a logoff on behalf of the attached MAC address when the PC-port device disconnects|
|8021x_method||null, eap-md5, peap-mschap, eap-tls, peap-gtc, ttls-mschap, ttls-gtc|
Sets the method of 802.1X authentication for the phone, defaults to null (none).
Sets the 802.1X authentication identifier (username), defaults to null (none).
null, string, PHONE_MAC
|Sets the 802.1X anonymous authentication identifier (username), defaults to null (none), can be set to "PHONE_MAC" to pass phone's MAC address|
Sets the 802.1X authentication password, defaults to null (none)
|8021x_client_cert_url||null, http(s) or ftp(s) URL||Sets the URL the phone will cURL its 802.1X client certificate from|
|8021x_client_cert_value||string||Sets the local name the phone should use when storing the certificate. Phone will retrieve a new certificate when factory defaulted or when value changes.|
|8021x_root_cert_url||null, http(s) or ftp(s) URL||Sets the URL the phone will cURL its 802.1X root (CA) certificate from|
|8021x_root_cert_value||string||Sets the local name the phone should use when storing the certificate. Phone will retrieve a new certificate when factory defaulted or when value changes.|
|8021x_debug||null, -d, -dd||Sets the debug level to be used when troubleshooting 802.1X authentication errors. Phone will generate error report that can be utilized by Digium Support. Phone should not be configured to operate in this mode on an ongoing basis as it will generate excessive messages. Defaults to null (none)|
|codecs||null, PCMU, PCMA, G722, G7221, G726-32, opus, G729, iLBC, L16, L16-256||Enables or disables codecs and sets the codec priority. To disable, prefix a codec name with an "!". Earlier entries have higher priority. Not all codecs apply to all models of phones.|
|openvpn_enable||0, 1||When enabled, and when necessary config files are present, the phone will run the OpenVPN client on boot. Applies to D6x models of phones.|
|openvpn_config_file_url||null, http(s) or ftp(s) URL||Sets the URL the phone will cURL its OpenVPN client configuration file from|
|openvpn_config_file_value||string||Sets the local name the phone should use when storing the openvpn configuration file. Phone will retrieve a new config file when factory defaulted or when value changes.|
|openvpn_root_cert_url||null, http(s) or ftp(s) URL||Sets the URL the phone will cURL the OpenVPN CA cert from|
|openvpn_root_cert_value||string||Sets the local name the phone should use when storing the openvpn root certificate. Phone will retrieve a new certificate file when factory defaulted or when value changes.|
|openvpn_client_cert_url||null, http(s) or ftp(s) URL||Sets the URL the phone will cURL the OpenVPN client certificate from|
|openvpn_client_cert_value||string||Sets the local name the phone should use when storing the openvpn client certificate. Phone will retrieve a new certificate file when factory defaulted or when value changes.|
|openvpn_client_key_url||null, http(s) or ftp(s) URL||Sets the URL the phone will cURL the OpenVPN client key from|
|openvpn_client_key_value||string||Sets the local name the phone should use when storing the openvpn client key. Phone will retrieve a new key file when factory defaulted or when value changes.|
- the phone is assigned to a network called MyNetwork
- the phone is configured to use a firmware called 1.1Firmware
- the phone configuration is set for a phone whose MAC address matches 01:23:45:67:89:ab
- the phone configuration has a PIN of 10101019
- the phone has a group PIN of 1234
- the phone's primary line is a line named bob101, mapped to PJSIP endpoint bob101
- the phone's secondary line is a line named bob102, mapped to PJSIP endpoint bob102
- the phone has an external line called bobexternal
- the phone will load the application called queue-bob-1234
- the phone will load the application called available-working
- the phone will load the application called available-nopants
- the phone will load the application called parking-sales
- the phone will load the application called voicemail_for_de_DE
- the phone does not load an external configuration file
- the full name of the phone is Bob's Phone
- the phone loads a contacts XML file named bobscontacts.xml
- the phone loads a contacts display rules file called bobsdisplayrules.xml
- the phone uses a contact group, from bobscontacts.xml, named "RapidDial" for its BLF keys
- the phone loads a BLF Items file called bobsblfitems.xml
- the phone will return to the first page of BLF results, if it's a D65, after 30 seconds
- the phone is configured to allow 50 Contacts BLF subscriptions
- the phone is set for the "America/Los_Angeles" timezone
- the phone's NTP resynchronization time is 86400
- the phone will blind transfer parked calls to extension 700
- the phone's parking lot application will be visible
- the phone loads a ringtone called FancyTone
- the phone's active ringtone is a Guitar Strum
- the phone's Web UI is disabled
- one touch call recording is enabled
- the call forward application is enabled
- the call log application is enabled
- the phone has been configured with an Alert called fancyringer
- the phone's Rapid Dial keys will begin from the side car
- the phone's Send VM and Transfer VM keys are enabled
- the phone stores contacts on the server
- if the phone claiming the profile is a D40, it will use the logo file d40_logo.png
- if the phone claiming the profile is a D50, it will use the logo file d50_logo.png
- if the phone claiming the profile is a D70, it will use the logo file d70_logo.png
- if the phone claiming the profile is a D80, it will use the logo file d80_logo.png
- if the phone is a D6x model, the phone will display a wallpaper my_wallpaper.png
- the phone's EHS is set to auto, to operate with any of the supported EHS types
- the phone's preferences are locked to the server's settings
- the phone's login password id 1234
- the phone will only accept local calls
- the phone will display missed call notifications
- the phone will display an idle company text of Office Phone
- if the phone is a D6x model, the phone will display a small clock
- the phone's brightness is 5
- the phone's contrast is 5
- the phone's backlight will dim
- the phone's backlight will dim after 30 seconds
- the phone's backlight will dim to 2
- the phone's active_locale is de_DE
- the phone's ringer is at level 5
- the phone's speaker volume is 5
- the phone's handset volume is 5
- the phone's headset volume is 5
- the phone's volume does not reset after calls
- the phone will play a call waiting tone
- the phone does not answer to the headset by default
- the phone sends ringing tone to the loudspeaker
- the phone's contacts will show up lastname, firstname
- the phone's lan port is set to auto-negotiate
- the phone's pc port is set to 100 megabit, full-duplex operation
- the phone will respond to check-sync Events
[bobsphone] type=phone network=MyNetwork firmware=1.1Firmware mac=0123456789ab pin=10101019 group_pin=1234 line=bob101 line=bob102 external_line=bobexternal application=queue-bob-1234 application=available-working application=available-nopants application=parking-sales application=voicemail_for_de_DE ;config_file full_name=Bob's Phone contact=bobstonctacts.xml contacts_display_rules=bobsdisplayrules.xml blf_contact_group=RapidDial blf_items=bobsblfitems.xml blf_page_return_timeout=30 contacts_max_subscriptions=50 timezone=America/Los_Angeles ntp_resync=86400 parking_exten=700 parking_transfer_type=blind show_call_parking=yes ringtone=FancyTone active_ringtone=GuitarStrum web_ui_enabled=no record_own_calls=yes can_forward_calls=yes show_call_log=yes alert=fancyringer blf_unused_linekeys=no send_to_vm=yes d40_logo_file=d40_logo.png d45_logo_file=d45_logo.png d50_logo_file=d50_logo.png d70_logo_file=d70_logo.png d80_logo_file=d80_logo.png wallpaper_file=my_wallpaper.png ehs=auto lock_preferences=yes login_password=1234 accept_local_calls=host display_mc_notification=no idle_company_text=Office Phone small_clock=yes brightness=5 contrast=5 dim_backlight=yes backlight_timeout=30 backlight_dim_level=2 active_locale = de_DE ringer_volume=5 speaker_volume=5 handset_volume=5 headset_volume=5 reset_call_volume=no call_waiting_tone=yes headset_answer=no ring_headset_only=no name_format=last_first lan_port_mode=auto pc_port_mode=100fd enable_check_sync=yes codecs=PCMU,PCMA,G722,G7221,G726-32,opus,G729,iLBC
string, e.g. 1000
When the PJSIP endpoint name is different than the actual extension used to contact this line, this option should be set to the line's dialable extension. By default it is assumed that the PJSIP endpoint is actual dialable extension, which is true for most Asterisk distributions such as FreePBX and AsteriskNOW, but is not considered a best practice for use of generic Asterisk.
Digit mapping, see #dialplans
The digit mapping to use for this line.
string, e.g. MD 123
The line label to display on the phone for this line's line key.
mailbox from voicemail.conf
The voicemail box associated with the line. When not set, this will default first to the mailbox defined for the PJSIP endpoint associated with the line, and second to a mailbox entry in voicemail.conf matching the name of the line. If neither of these are found and this option is not set, the line does not have a mailbox and visual voicemail will not be enabled. If PJSIP endpoints are stored using Sorcery rather than the flat pjsip.conf file, then the mailbox to which the PJSIP endpoint is assigned must be specified here, as it cannot be retrieved by the DPMA from Sorcery .
If the phone's Msgs button should dial a SIP URI rather than opening the visual voicemail application, this option specifies what URI the Msgs button should dial. Setting this option on a phone's primary lie will disable visual voicemail.
Host / IP address
The Outbound SIP proxy address this line should use
Port as integer
The port of the Outbound SIP proxy; defaults to 5060 when outboundproxy_address is set
udp, tcp, tls
SIP transport method this line should use. If not specified, the network transport is preferred. Using tls or tcp as a transport for phones attached to DPMA requires Asterisk 13.11.0 or greater.
|media_encryption||null, sdes||Specifies media encryption protocol. Can be set to sdes, defaults to not set (none).|
integer, e.g. 300
The number of seconds before re-registering
integer, e.g. 25
The number of seconds to wait before retrying to register after registration fails.
integer, e.g. 5
The number of times the phone will attempt to retry registering after registration fails
string, e.g. mymagicpassword
If PJSIP endpoints are stored using Sorcery rather than the flat pjsip.conf file, then the secret for the PJSIP endpoint mapped to this line must be specified so that the Digium phone can be passed the correct PJSIP endpoint credentials.
Asterisk dialplan context
If PJSIP endpoints are stored using Sorcery rather than the flat pjsip.conf file, then the dialplan context to which the PJSIP endpoint is assigned must be specified so that dialplan hints can be properly created by DPMA.
caller id string, e.g. "Bob Jones" <1234>
If PJSIP endpoints are stored using Sorcery rather than the flat pjsip.conf file, then the caller ID for the PJSIP endpoint mapped to this line should be specified so that the Digium phone can be provided with a proper Caller ID.
Asterisk dialplan context
Allows for overriding of the line's subscription context. If defined here will override the setting from Asterisk's PJSIP configuration
|plar_number||Dialable Number||When set, specifies a number that will be automatically dialed when this line is taken off hook on the phone. Defaults to null (do not automatically go off-hook and dial a number). D6x models beginning with firmware 22.214.171.124.|
In this example:
- the Digit Mapping for the phone is set to [0-8]xxx
- The Label for the line, as it appears on the phone is BobbyJ
- The Mailbox for the line is bob101
- the Outbound Proxy is 10.10.10.1 and its port is 5060.
- The Transport type for the signaling is TCP
- Media Encryption is enabled
- The Re-registration timeout is 300 seconds
- The Registration Retry Interval is 25 seconds
- The Maximum Registration Retries is 5 times