FIELD NAME

DESCRIPTION

VALUE

Number

Extension Number

Required - numeric values only

FirstName

First Name

Alphanumeric

LastName

Last Name

Alphanumeric

EmailAddress

Email Address

Aphanumeric

MobileNumber

Mobile Number

Numeric values only

AuthID

SIP Authentication ID

Required - aphanumeric

AuthPassword

SIP Authentication Password

Required - aphanumeric

WebMeetingFriendlyName

Webmeeting Friendly Name

Extension MUST have an email address and Name. This will be the alphanumeric ID for the webmeeting URL for this extension.

WebMeetingPrivateRoom

Create new room for each participant

0 – Generate new room for each new anonymous participant

1 – Shared room for all anonymous participants

ClickToCall

Set ClickToCall option for this extension

0 - Disable ClickToCall

1 - Enable ClickToCall

ClickToCallFriendlyName

ClickToCall Friendly Name

Unique alphanumeric string, without spaces.

Example:

WebMeetingAcceptReject

Moderate participants

0 – Disable Moderate participants

1 – Enable Moderate participants

EnableVoicemail

Enable Voice Mail Box for this extension

0 – Voicemail is disabled

1 – Voicemail is enabled

VMNoPin

Disable Voicemail PIN authentication

0 – Pin Authentication for voicemail is disabled

1 – Pin Authentication for voicemail is enabled

VMPlayCallerID

Play Caller ID

0 – Do not play Caller ID

1 – Play Caller ID

PIN

PIN number used to access voicemail box

Numeric

VMPlayMsgDateTime

Read out date/time of message

0 – Do not read Date/Time of message

1 – Read in AM/PM Format

2 – Read in 24hr format

VMEmailOptions

Email options

0 – No email notification is generated when the extension receives voicemail

1 – Email notification is sent

2 – Email Notification with voicemail attached will be sent.

3 – Email notification with vmail attached will be sent and vmail file will be deleted from the server.

QueueStatus

Queue status

0 – Logged out of Queues

1 – Logged in Queues

OutboundCallerID

Outbound Caller ID

Alphanumeric – Configures the Outbound Caller ID for the extension

SIPID

SIP ID

Alphanumeric – Configures the SIP ID for the extension

DeliverAudio

PBX delivers Audio

0 – PBX does not deliver audio

1 – PBX delivers audio

SupportReinvite

Supports Re-invite

0 – Reinvites not supported

1 – Reinvites supported

SupportReplaces

Support Replaces header

0 – Does not support Replaces Header

1 – Supports Replaces Header

EnableSRTP

Switch on Secure RTP (SRTP)

0 – Disabled

1 – Secure SRTP on

ManagementAccess

Allow 3CX Management Console Access

0 – 3CX Management Console access not allowed

1 – 3CX Management Console access enabled + user can manage his own Extension

2 – 3CX Management Console access enabled + User is set as Group / Department manager (can manage the extensions of the groups he is a member of)

3 – 3CX Management Console access enabled + user is set as a Global Extension Manager (can manage all user extensions on the System)

ReporterAccess

Allow 3CX Web Reports Access

0 – 3CX Reports access not allowed

1 – 3CX Reports access enabled

WallboardAccess

Allow 3CX Wallboard Access

0 – 3CX Wallboard access not allowed

1- 3CX Wallboard access enabled

TurnOffMyPhone

Disallow use of 3CXPhone

0 – 3CX app use is enabled

1 – 3CX app use is disabled

HideFWrules

Hide Forwarding Rules

0 – Forwarding Rules tab enabled in the 3CX app

1 – Forwarding Rules tab disabled in the 3CX app

CanSeeRecordings

Show Call Recordings

0 – Call recordings not shown to the user

1 – Call recordings shown to the user

CanDeleteRecordings

Allow deletion of recordings

0 – Does not allow the deletion of recordings by the user

1 – Allows deletion of recordings by the user

RecordCalls

Record all calls

0 – Do not record all calls

1 – Record all calls for this extension

CallScreening

Call screening ON

0 – No Call Screening

1 – Enable Call Screening

EmailMissedCalls

Send email notification on missed call

0 – Do not send email notification on missed call

1 – Send email notification on missed call

Disabled

Disable Extension

0 – Extension is enabled

1 – Extension is disabled

DisableExternalCalls

Disable External Calls

0 – External calls enabled

1 – External calls disabled

AllowLanOnly

Disallow the use of extension outside the LAN

0 – Use of extension outside LAN is enabled

1 – Use of extension outside LAN is disabled

BlockRemoteTunnel

Block Remote Tunnel Connections

0 – Remote tunnel connections enabled

1 – Remote tunnel connections disabled

PinProtect

Pin Protect

Numeric value in seconds – user has to type a pin to allow external calls in the time allocated

MAC_0

MAC Address of the first provisioned phone.

Alphanumeric hexadecimal string without spaces or dashes.

InterfaceIP_0

Select Interface

3CX Phone System IP address

UseTunnel

Use 3CX Tunnel for Remote Connections (3CX app only)

0 – Do not use tunnel for Remote Connections

1 – Use tunnel for Remote Connections

DND

DND

0 – Do Not Disturb off

1 – Do Not Disturb on

UseCTI

Configure default phone to use in 3CX Phone for windows

empty – default phone to use in 3CX app for windows not specified

0 – Use Inbuilt Softphone

1 – use IP Phone via CTI

StartupScreen

Default Startup Screen

0 – Dialpad as Start up screen

1 – Presence screen as Start up screen

HotelModuleAccess

Allow 3CX Hotel Module Access

0 – Extension cannot access 3CX Hotel module

1 – Extension can access 3CX Hotel module

DontShowExtInPHBK

Do not show Extension in 3CX Company phonebook

0 – Extension is shown in 3CX Company Phonebook

1 – Extension is not shown in 3CX Company Phonebook

DeskphoneWebPass

Phone Web Page Password

Required - alphanumeric password used to access the IP Phone’s web configuration pages.

SrvcAccessPwd

Access password for 3CX Web Services

Alphanumeric – this is the password used to access the 3CX Web services (3CX Management Console)

VoipAdmin

Voip Trunk Administrator

0 – User is not allowed to manage VoIP Gateways, VoIP Providers and 3CX Phone System Bridges

1 – User is allowed to manage VoIP Gateways, VoIP Providers and 3CX Phone System Bridges

SysAdmin

System Administrator

0 – User is allowed to modify System Extensions (Queues, Ring groups, Digital Receptionists), change System Settings and perform 3CX Phone System Updates

1 – User is not allowed to modify System Extensions (Queues, Ring groups, Digital Receptionists), change System Settings and perform 3CX Phone System Updates

SecureSIP

Enable Secure SIP (TLS)

0 – Secure SIP is not enabled for this user

1 – Secure SIP is enabled for this user

PhoneModel14

Phone Model name

Model of the first provisioned phone

PhoneTemplate14

Template used by the  IP phone for provisioning

Template file name

CustomTemplate

Custom template used for Hardpphone provisioning

Custom template file name

PhoneSettings

Custom Settings of Phone from extension

Custom settings of the first provisioned phone will be shown in the following format:

<PhoneDevice ProvType="0" PhoneLanguage="English" XferType="BXfer" RingTone="Ring 1" DateFormat="WWW MMM DD (Mon Jan 15)" TimeFormat="24-hour clock"

AllowAllRecordings

Ability to download All Recordings

0 – Not allowed to download all recordings

1 – Allowed to download all recordings

PushExtension

Enable Push for Smartphones

0 – Push notifications disabled

1 – Push notifications enabled

Integration

Enable Integration for the Extension with 3CX Plugins (Legacy)

Empty – Disable Integration. To enable Integration you need to set specific plugin . For example

AllowOwnRecordings

Enables the user to start and stop call recording

0 – Disallow user to control call recording

1 – Allow user to control call recording

RecordExternalCallsOnly

Enables recording only for external calls

0 – Disable external calls only  recording mode

1 – Enable external calls only recording mode

DID

List of DIDs assigned to the extension, separated by colon (:)

Example: