Versions Compared

Key

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

XML Configuration

...

XML Configuration

This section describes the formatting and options available when creating XML-based configuration files for provisioning Sangoma phones. 

...

Option

Values

Description

Models

server_uuid

Non-zero String

Specifies a unique identifier for the server.

P320, P325, P330, P370

index

integer (0-5)

Defines the line key to which the account will be mapped.

There is no default index value. This option is mandatory.

P320, P325, P330, P370

status

boolean

If 1, enables the account's line key. If 0, will not display the account's line on the phone or register with the primary host.

Defaults to 0.

P320, P325, P330, P370

register

boolean

If 1, then this account will attempt to register with the primary host. If 0, then registration will not be performed for this account.

Defaults to 0.

P320, P325, P330, P370

account_id

string

For Switchvox systems, the Switchvox account_id associated with the SIP account. For non-Switchvox systems, a unique identifier, not necessarily related to any SIP credentials.

P320, P325, P330, P370

username

string

SIP username

P320, P325, P330, P370

authname

string

SIP authname

P320, P325, P330, P370

password

string

SIP password

P320, P325, P330, P370

passcode

string

SIP password

P320, P325, P330, P370

line_label

string

The text that shows up next to the line key for this account

P320, P325, P330, P370

caller_id

Name <Number>

Outgoing caller id displayed for this account

P320, P325, P330, P370

dial_plan

Digit mapping, see Dial Plans

The dial plan / digit mapping for this account

P320, P325, P330, P370

visual_voicemail

boolean

Only valid on account with index of 0. Only valid for phones provisioned by Switchvox or the DPMA. If 1, then the Msgs button action will open the voicemail app. If 0, then the Msgs button will be mapped to the extension defined for the voicemail option.

Defaults to 0.

P320, P325, P330, P370

voicemail

digits or SIP URI

A SIP URI or extension to be dialed for voicemail pertaining to this account.

P320, P325, P330, P370

needMwiSubscription

boolean

If 1, the phone will subscribe for MWI for this account. If 0, the phone will not subscribe for MWI for this account.

Defaults to 0.

P320, P325, P330, P370

plar_number

string

If defined, the phone will dial the configured string as a URI when the account is taken off-hook.

P320, P325, P330, P370

ring_type

normal, answer, ring-answer, visual

Allows control over the default ringing type for this account in the absence of any explicit Alert-Info header. Defaults to normal.

P320, P325, P330, P370

subscription_extension

string

For DPMA-connected phones, defines the user-part to which the phone should subscribe for presence updates

P320, P325, P330, P370

mwi_subscription_uri

SIP URI e.g.:
sip:mailbox@host 

If empty, subscribe to the host_primary using the SIP username. If non-empty, allows definition of the URI for MWI subscription

P320, P325, P330, P370

...