background image

Example General Section configuration.

[general]

globalpin=344486

userlist_auth=disabled

config_auth=mac_globalpin

registration_address=10.10.10.10

registration_port=5060

service_name=Go 4 Phones

service_discovery_enabled=yes

firmware_url_prefix=http://10.10.10.10/digium_phones_firmware

firmware_package_directory=/var/www/digium_phones_firmware

file_directory=/var/lib/asterisk/digium_phones

message_context=dpma_message_context

Phone Configuration Options

Phones profiles are configured by defining a context with type option equal to “phone.” A Phone profile can have any number of lines associated
with it. Each line defined in the configuration is reflected as a separate line key on the phone; and, when provisioned, is ordered on the phone
itself as it is in the profile configuration.

The first line key associated with a Phone profile is set internally as the phone’s primary line. The primary line is the only one listed in the User list
on boot up. The primary line is also used to automatically match the phone to voicemail boxes.
The following options are provided for Phone configuration:

Option

Values

Description

mac

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.

pin

integer; e.g. 10101019

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

line

entity defined as line in
res_digium_phone.conf

Maps directly to a sip.conf peer/friend 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.

external_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

config_file

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. For information about custom configuration files, see 

.

[\#xmlconfig|]

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.

full_name

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

contact

file, e.g. contacts.xml

An xml file in the file_directory containing a list of contacts to serve to the phone. Multiple
contact options can exist in a single phone configuration.

blf_contact_group

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.

timezone

Timezone String, e.g.
America/Chicago

Sets the timezone used for the clock on this phone.

ntp_server

hostname, IP address,
e.g.
ntp.mycompany.com

Defines the NTP server to which phones will synchronize themselves

ntp_resync

seconds as integer,
e.g. 86400

Defines the interval between NTP synchronization

Summary of Contents for DPMA

Page 1: ...hones aren t hard like everyone thinks that are and they re not dumb terminals instead they re simple and smart A Digium phone can communicate with Asterisk or with any other SIP based system In this...

Page 2: ...The phone s boot menu Digium Configuration Server DPMA manual address Fetch Configuration file from URL HTTP HTTPs Manual SIP account entry The phone s web based configuration tool DPMA Bonjour mDNS...

Page 3: ...e at boot in order to retrieve the list of available phone configurations If config_auth is set to globalpin sets the PIN that must be entered on a phone at the userlist screen in order to request a p...

Page 4: ...ecifies the URL prefix the phone module should use to tell the phones where to retrieve firmware files firmware_package_directory file path e g var www firmware_package_directory Specifies the actual...

Page 5: ...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 exte...

Page 6: ...pixels 8 bit depth a color type without alpha transparency and less than 10k in size Loaded from the directory specified by the option The D40 and D50 screen size is the same therefore it file_directo...

Page 7: ...terisk distributions such as FreePBX and AsteriskNOW but is not considered a best practice for use of generic Asterisk digit_map Digit mapping see dialplans The digit mapping to use for this line line...

Page 8: ...he actual peer External Line Configuration Options External lines are external to this Asterisk instance they are lines that are not entries in sip conf The external line concept exists to work around...

Page 9: ...1 transport tcp secondary_server_Address otherpb2 mycompany com secondary_server_port 5061 secondary_server_transport udp userid bob1234 authname bob4321 secret mymagicalpassword registration yes call...

Page 10: ...s last_name Jones suffix III contact_type sip organization Digium job_title Direction Manager location East Texas notes account_id 104 subscribe_to sip 104 1 2 3 4 numbers number dial 104 dial_prefix...

Page 11: ...ng with 011 followed by at least 4 more digits after a delay of 3 seconds Dial numbers beginning with 1 followed by 10 digits immediately Dial numbers beginning with 2 9 followed by 6 digits immediate...

Page 12: ...to a phone model and a firmware version Example Example digium_phones_firmware conf file in a Digium maintained firmware package D40 version 1_0_3_45441 file 1_0_3_45441_D40_firmware eff D50 version 1...

Page 13: ..._mode value NONE network 10 10 0 0 16 setting id network_vlan_qos value 0 setting id network_vlan_id value 44 setting id log_level value debug setting id enable_logging value 0 setting id log_server v...

Page 14: ...ert_info ring answer ringtone_id Digium ring_type ring answer alert alert_info intercom ringtone_id ring_type answer alert alert_info visual ringtone_id ring_type visual alerts ringtones appconfig id...

Page 15: ...id reset_call_volume value 0 setting id default_ringtone value Digium setting id active_ringtone value Digium setting id headset_answer value 0 setting id desi_strip_enable value 1 setting id enable_...

Page 16: ...s the local TCP SIP port defaults to 5060 Preferences Idle Screen logo_file as factory user as location on disk of file factory_asterisk png for default value path and user_image png for custom as opt...

Page 17: ...disables presence subscriptions Defaults to 40 blf_contact_group Any Group ID from the loaded contacts The ID of the contact list group to use for the rapid dial list Network IP Settings network_enabl...

Page 18: ...ample Accounts Element Example xml version 1 0 config accounts account index 0 status 1 register 1 account_id 100 username 100 authname 100 password 100 passcode 100 line_label 100 Alligator caller_id...

Page 19: ...for this account are directed port integer 1 65535 Sets the server s SIP port transport udp tcp Sets the transport type UDP or TCP reregister integer in seconds Sets the re registration interval retry...

Page 20: ...ilable codecs each described by an individual codec element and its attributes Each codec element is described by the following attributes Option Values Description id PCMU PCMA G722 G726 32 G729 L16...

Page 21: ...s Option Values Description id string Internal Tone identifier display string External Tone Description url URL string Location from which to retrieve a 16kHz mono WAV sound file less than 1MB in size...

Page 22: ...he phone will check the version string against an internal copy of the string as previously loaded If the strings differ the phone will load the new firmware url http URL string URL location of the ph...

Page 23: ...ss insecure port has been set A minimum SIP conf entry for a Digium phone then would look like SIP Configuration Entry Example mydigiumphone type friend Use of friend is good practice generally nat fo...

Page 24: ...or a Digium Phone in res_digium_phone conf e g voicemail conf Voicemail Configuration Example for Voicemail Application fancycontext The voicemail context name 100 12345 Bob Bobby bobbobby example com...

Page 25: ...atus of a BLF lamp to the activity of a parking slot does not require setting the parking_exten but it does require enabling Asterisk s parking feature as well as a proper dialplan hint and a proper s...

Page 26: ...r presence is changed by a CustomPresence user presence provider A CustomPresence provider works in the same way a Custom device state provider does CustomPresence providers are both defined and updat...

Page 27: ...h of batarangs Example2 Building on example1 now set Batman s state to extended away with no subtype while maintaining the message Making a new batch of batarangs Set PRESENCE_STATE CustomPresence Bat...

Page 28: ...mPresence Batman message Example4 Reading subtype and message fields as base64 values Action Getvar ActionID 1234 Variable PRESENCE_STATE CustomPresence Batman subtype e Action Getvar ActionID 1234 Va...

Reviews: