Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Auto provisioning works with Option 66 to allow a SIP phone or gateway to provision itself by loading a configuration file hosted on the Voiceware server. Use of this feature is encouraged because it will save a lot of time during and post installation.

...

Expand
titleVariable Usage Example

Here is an example of a VTech 715 template file:

sip_account.1.sip_account_enable = 1

sip_account.1.display_name = {$config.reg1.friendly_name}

sip_account.1.user_id = {$config.reg1.username}

sip_account.1.authentication_name = {$config.reg1.username}

sip_account.1.authentication_password = {$config.reg1.secret}

sip_account.1.dial_plan = {$config.digitmap}

sip_account.1.inter_digit_timeout = 3

sip_account.1.maximum_call_number = {$config.reg1.sip_calllimit}

When the config file is written out using this template the resulting file looks like this:

sip_account.1.sip_account_enable = 1

sip_account.1.display_name = John Smith

sip_account.1.user_id = 302

sip_account.1.authentication_name = 302

sip_account.1.authentication_password = bh44kd#dk34$r1

sip_account.1.dial_plan = Xn.

sip_account.1.inter_digit_timeout = 3

sip_account.1.maximum_call_number = 2

Note that the configuration file itself normally contains human readable information. In the above example it’s easy to see the display name is “John Smith” and the user ID is “302”. Also note that some values are pre-loaded in the template file. For example the top line of “sip_account_enable” is preset to “1” which enables the account. Voiceware does not have an equivalent option in its GUI so this value is pre-loaded into the template file and thus into every config file created with this template.

This concept of preloading is very important as it allows a reseller to make custom adjustments to every configuration file by just adjusting the template file. Say for example that every guest room phone needed to have the same speed dial values. The template file could be adjusted and placed back into the system (see below for instructions on how to do this) and then all configuration files created would have the same speed dial keys.

Data Sample

Below is an example of each field and sample data that will be outputted to it.

phone_id

117

reg2.sip_dtmfmode

rfc2833

mac

1122334455

reg2.sip_speakerphone

http_iface

1

reg2.friendly_name

Rachel Summers

pc_port

-1

reg2.sla_group

dnd

0

keys2

1

call_fwd

0

mcd2

vm_sa

silence

digitmap

vm_la

disabled

vmext

8000

stickyvol_head

1

cwt

beep

stickyvol_spkr

1

timeoffset

-18000

stickyvol_hand

1

myip

192.168.2.105

hold_remind

0

dst

1

hold_remind_per

30

parkkey

1

hold_remind_start

60

parkext

700

reg1.id

465

qtext.0.xfer_dest

300

reg1.name

300

qtext.0.xfer_label

Fast One

reg1.accountcode

sdext.0.sd_dest

301

reg1.username

300

sdext.0.sd_label

Custom 1

reg1.secret

Ce323uSu$#A3yMU

sdext.0.blf

1

reg1.qualify

yes

qtext.1.xfer_dest

reg1.allow

ulaw,alaw,gsm

qtext.1.xfer_label

reg1.disallow

sdext.1.sd_dest

302

reg1.port

5060

sdext.1.sd_label

Custom 2

reg1.language

sdext.1.blf

reg1.sip_calllimit

6

admin_pwd_set

1

reg1.sip_dtmfmode

rfc2833

admin_pwd

2150

reg1.sip_speakerphone

vlan_id_set

0

reg1.friendly_name

Jubilation Lee

vlan_id

reg1.sla_group

dns_ip_set

0

keys1

2

dns_ip

mcd1

1

syslog_server_set

1

reg2.id

75

syslog_server

192.168.2.50

reg2.name

312

syslog_level

1

reg2.accountcode

reg2.username

312

userdata.username

jlee

reg2.secret

7366%^#88Adf

userdata.firstname

Jubilation

reg2.qualify

yes

userdata.lastname

Lee

reg2.allow

ulaw,alaw,gsm

userdata.pin

975039

reg2.disallow

userdata.outbound_id

3035551111

reg2.port

5060

userdata.lang

en

reg2.language

userdata.timezone

America/Detroit

reg2.sip_calllimit

6

config.ringdown2

888

config.polarity2

loop | ground |

Template File Supported Options

...

Expand
titleVtech Phones

Vtech Snom

V 1.0 20190218

  • Created the phone template

V 1.1 20190715

  • Added the ability to disable the PC port

V 1.2 20190808

  • Changed the default clock display to 12-hour format

V 1.3 20190913

  • Added a flag to set the phone to accept paging calls, it’s called answer_after_policy.

  • Improved the way that the digit map is handled (faster dial upon pattern match).

V 1.4 20200221

  • Added three template default digit maps to help aid in dialing. These improvements include [8-9]011.....*, [8-9]......*, and * with a timeout of 10 seconds.

  • Edited the numbers the phone thinks are emergency numbers to remove 112 and 999 and add 8911 and 9911.

V 1.5 20210212

  • Set the default ring tone to tone 9 for all lines.

  • Made *97 the default directed call prefix.

  • Set speed dials to type BLF, not Extension.

V 1.6 20210402

  • Added a setting so the phone will automatically refresh its settings once every two hours. This was done so that settings changes made to the Endpoint in Voiceware will take effect automatically without requiring the user to reboot their phone.

V 2.0 20221028 (Tested on firmware 10.1.127.10, 10.1.119.10, and 10.1.33.3)

  • Created a separate file for the D713, D717, D735, and D785. This removes the need to set DHCP option 66 with a Vtech specific value.

Vtech_S2XXX

V1.2 20210618

  • Updated template so that unsupported options are hidden in the Voiceware GUI.

V 1.1 20180801

  • Added support for the config version number, previously it was hard coded to 999

VPS715

V 1.4 20171115

  • Added support for call waiting tone enable / disable via the GUI

  • Changed clock to 12-hour format

  • Changed date format to MM/DD/YY

VSP725

V 1.3 20171115

  • Added support for call waiting tone enable / disable via the GUI

  • Changed clock to 12-hour format

  • Changed date format to MM/DD/YY

VSP726

V 1.4 20171115

  • Added support for call waiting tone enable / disable via the GUI

  • Changed clock to 12-hour format

  • Changed date format to MM/DD/YY

  • Changed adaptive jitter delay to 30 and target to 45

  • Set to auto configure nightly and update its configuration

VPS736

V 1.3 20171115

  • Added support for call waiting tone enable / disable via the GUI

  • Changed clock to 12-hour format

  • Changed date format to MM/DD/YY

  • Changed adaptive jitter delay to 30 and target to 45

  • Set to auto configure nightly and update its configuration

Vtech LS-S3410

Version 1.1 20210618

  • Updated template so that unsupported options are hidden in the Voiceware GUI.

Vtech CTM-S2315

Version 1.0 20210624

  • Built on firmware 2.18.2.0

  • Speed dial keys are assigned M1, M2, M5, M6, M7, M8

  • Note that the emergency extension must be manually set in the template file, not via the Voiceware GUI.

  • Time zone must be manually set in the template file.

Vtech CTM-S2116

Version 1.0 20210624

  • Built on firmware 2.18.6.0

  • Speed dial keys are assigned Front Desk, room Service, Restaurant, Housekeeping, Valet

  • Note that the emergency extension must be manually set in the template file, not via the Voiceware GUI.

  • Time zone must be manually set in the template file.

Vtech CTM-S2411-L

Version 1.0 20210624

  • Built on firmware 2.19.0.0

  • Speed dial keys are assigned lower row left to right, upper row left to right, top down buttons right of key pad.

  • Note that the emergency extension must be manually set in the template file, not via the Voiceware GUI.

  • Time zone must be manually set in the template file.

Vtech CTM-S2415

Version 1.0 20210624

  • Built on firmware 2.18.4.0

  • Speed dial keys are assigned HS M1, M2, BS 1-4.

  • Note that the emergency extension must be manually set in the template file, not via the Voiceware GUI.

  • Time zone must be manually set in the template file.

Vtech M500 Base Station

Version 1.0 20230825. Tested on firmware 1.11.3

  • Auto provision uses option 159NOT 66 as normal.

  • Auto provision is set to disabled after initial configuration.

  • Must use /{mac}.xml in the provisioning URL.

  • A devices display name should be shorter, the name “Jonothon Starsmore” was to long and did not display on the phones (desk and cordless).

  • Speed dials and additional line keys must be manually set by logging into the base station for each hand or desk set.

...