|
brand
|
String
|
Phone brand name (all lowercase).
|
|
family
|
String
|
Phone family name (all lowercase).
|
|
model
|
String
|
Phone model name (all lowercase).
|
|
settings
|
Object
|
Model-specific settings.
|
|
user_agent
|
String
|
String subset of User-Agent that will be required for authentication.
|
|
template_file
optional
|
String
|
Provisioning template filename. If not specified, a generic brand-specific template will be used (and must be present in the templates directory) e.g. yealink.xcfg, grandstream.xcfg.
|
|
token_use_limit
optional
|
Number
|
Number of times the initial URL token can be used without a username/password before the phone auto-locks.
Default value: 3
|
|
provisioning_protocol
optional
|
String
|
Set to 'PROTOCOL:[PORT]' to allow this phone model to provision over unencrypted HTTP (overrides the global allow_http_provisioning setting in the config file.) Example: HTTP or HTTP:8080
Use this setting with discretion to avoid data leakage and toll fraud!
Default value: HTTPS
|
|
content_type
optional
|
String
|
Content type that the phone expects (text/xml is the default).
Default value: text/xml
|
|
combo_keys
optional
|
Object
|
Combo Keys Object
|
|
quantity
optional
|
Number
|
Number of line/combo keys on this phone.
|
|
feature_keys
optional
|
Object
|
Feature Keys Object
|
|
quantity
optional
|
Number
|
Number of feature keys on this phone.
|
|
voicemail_code
optional
|
String
|
Voicemail code to use for this device model, if different than default.
|
|
firmware
optional
|
Object|String
|
Firmware Object (or string)
|
|
version
optional
|
String
|
Desired firmware version for this device model.
|
|
upgrades
optional
|
[]Object
|
An array of upgrade path objects for specific firmware versions to update to other specific versions. This way, you can avoid manually upgrading phones with certain bugs in particular firmware versions that require an upgrade or downgrade to a specific version before upgrading to a later version.
To lock a firmware version, set the from and to to the same value e.g. {"from":"5.4.7", "to":"5.4.7"}
In the API example shown, the last phone model being added is a Yealink T46U. For it, we specified a target firmware of 108.86.0.70, with three upgrade paths. T46U phones with firmware of 108.83.x.x (any version 83 firmware) will upgrade first to 108.84.0.10, then to 108.85.0.90, before finally upgrading to the desired version 108.86.0.70. T46U Phones with version 108.84.0.35 will first downgrade to 108.84.0.10 before going to 108.85.0.90 and then to the final version of 108.86.0.70.
|
|
upgrade.from
|
String
|
If this firmware is found on the device, the accompanying to entry will be the upgrade version. You may use a regular expression here, by prefixing the from string with a tilde ~ character.
Example: ~^66\.83 This will match any firmware version starting with 66.83.
Example: ~0\.15$ This will match any firmware ending in 0.15 like 66.84.0.15, 28.83.0.15, 28.84.40.15, 4.0.15 etc.
Note: Depending on your HTTP client you may need to use a double backslash \\ instead of single.
|
|
upgrade.to
|
String
|
This firmware version will be specified for the device to use, if the accompanying version in the from key is found on the device. Note: If you want to keep a model on a particular version that it has, set the same version for the from and to keys e.g.: {"from":"66.84.0.35", "to":"66.84.0.35"}. This particular example will lock this model to firmware 66.84.0.35 IF it already has that version on it, while devices with other firmware versions will upgrade to the version specified in settings.firmware.version.
|
