Extension Parameters
Descriptions for parameters in exported and imported Extension CSV file.
Parameter | Description | Importance | Restriction | Default Value |
---|---|---|---|---|
First Name | The first name of extension user. | At lease one is required | The maximum character length is
63. Note: First Name will be
filled with a value of Extension Number
if you leave these fields empty. |
Extension number |
Last name | The last name of extension user. | N/A | ||
Email Address | The email address of extension user. | Optional | Only numbers, letters, and characters @
_
-
.
The maximum character length is 255. |
N/A |
Mobile Number | The mobile number of extension user. | Optional | Numbers, letters, and characters (
)
.
-
+
*
# are allowed. The maximum character length is 31. |
N/A |
User Password | The password for extension user to log in to Linkus client and PBX web portal. | Required | Must contain numbers, uppercase, and lowercase letters. Restriction: Do
not allow four consecutive digits, four same digits,
extension number, first name, or last name. The
minimum character length is 10 and the maximum is
63. Note: User Password will
be generated randomly if you leave this field
empty. |
Generate Randomly |
Organization | The organization to which the extension user belongs. | Optional | Permitted value: The organization names that existed in PBX. Note:
Examples are given below:
|
Root organization, namely the Company Name. |
User Role | The role for extension user with PBX management permission. | Required | Permitted value: 0 or one of the role
names defined in the PBX. 0 means
[None]. Note: User Role will be
filled with default value 0 if you leave
this field empty. |
0 |
Extension Number | The extension's number. | Required | Extension Number cannot be duplicated, and only numbers are
allowed. The maximum character length is 7. |
N/A |
Caller ID | The caller ID that is displayed on the callee's device. | Required | Numbers, letters, and special characters (
)
.
-
+
*
# are allowed. The maximum character length
is 31. Note: Caller ID will be filled
with default value Extension Number
if you leave this field empty. |
Extension Number |
Registration Name | The registration name that is used to validate extension registration. | Required | The maximum character length is
63. Note: Registration Name will
be generated randomly if you leave this field
empty. |
Generate Randomly |
Registration Password | The password for the user to register the SIP extension. | Required | Must contain numbers, uppercase, and
lowercase letters. Restriction: Do not allow four
consecutive digits, four same digits, extension number,
first name, or last name. The minimum character length is 10 and the maximum is 63. Note: Registration
Password will be generated randomly if
you leave this field empty. |
Generate Randomly |
IP Phone Concurrent Registrations | How many SIP phones are allowed to register with the extension. | Required | Permitted value:
Note: IP Phone Concurrent
Registrations will be filled with
default value 1 if you leave this
field empty.
|
1 |
Emergency Outbound Caller ID | The outbound Caller ID for the extension when it makes emergency calls. | Optional | Numbers, letters, and characters (
)
.
-
+
*
# are allowed. The maximum character length is 31. |
N/A |
Enable Voicemail | Whether to enable or disable voicemail feature. | Required | Permitted value:
Note: Enable Voicemail will be filled
with default value 1 if you leave this
field empty. |
1 |
Voicemail PIN Authentication | Whether to enable or disable voicemail PIN authentication. | Required if Enable Voicemail = 1 | Permitted value:
Note: Voicemail PIN Authentication
will be filled with default value 1
if you leave this field empty.
|
1 |
Voicemail Access PIN | The PIN for authentication when accessing voicemail box. | Required if Enable Voicemail = 1 & Voicemail PIN Authentication = 1 | Only numbers are allowed. The minimum character length is 3 and the maximum is 15.Note: Voicemail Access
PIN will be generated randomly if you leave
this field empty. |
Generate Randomly |
Voicemail Language | The system prompt language used by the extension's voicemail. | Optional | Permitted value: follow_system or one of the
prompt language existed in PBX System Prompt (e.g.
German ).Note: Voicemail
Language will be filled with default
value follow_system if the language
you enter does not exist in PBX, or if you leave this
field empty.
|
follow_system |
New Voicemail Notification | The notification type for new voicemail. | Required if Enable Voicemail = 1 | Permitted value:
Note: New Voicemail Notification will
be filled with default value no if
you leave this field or Email Address empty.
|
no |
Send to | Specify the email address for receiving notification emails about new voicemails. | Required if Enable Voicemail = 1 & New Voicemail Notification = with_attach or without_attach | Permitted value:
|
user Email |
Voicemail Email Address | Enter a custom email address for receiving notification emails about new voicemails. | Required if Enable Voicemail = 1 & New Voicemail Notification = with_attach or without_attach & Send to = custom Email |
Only numbers, letters, and characters @ _ - . are allowed. Must start with a number, letter, or character _ and follow the email address format XXX@XXX.XX. The maximum character length is 255. |
N/A |
After Notification | The way to handle voicemail message in mailbox after receiving the message notification via email. | Required if Enable Voicemail = 1 & New Voicemail Notification = with_attach | Permitted value:
|
no |
Required if Enable Voicemail = 1 & New Voicemail Notification = without_attach | Permitted value:
|
no | ||
Play Date and Time | Whether to announce arrival time of the message before playing the voicemail message. | Required if Enable Voicemail = 1 | Permitted value:
Note: Play Date and Time will be
filled with default value 0 if you
leave this field empty.
|
0 |
Play Caller ID | Whether to announce caller ID of the party that left the message before playing the voicemail message. | Required if Enable Voicemail = 1 | Permitted value:
Note: Play Caller ID will be filled
with default value 0 if you leave
this field empty.
|
0 |
Play Message Duration | The duration of the message (in minutes) will be announced before playing the voicemail message. | Required if Enable Voicemail = 1 | Permitted value:
Note: Play Message Duration will be
filled with default value 0 if you
leave this field empty.
|
0 |
Send email notification when the User Password is changed | Whether to send email notification when the User Password is changed. | Required | Permitted value:
Note: Send email notification when the User
Password is changed will be filled with
default value 1 if you leave this
field empty.
|
1 |
Send email notifications on missed calls | Whether to send email notifications on missed calls. | Required | Permitted value:
Note: Send email notifications on missed
calls will be filled with default value
0 if you leave this field
empty.
|
0 |
Recording operation | Whether to allow users to switch their own recording status during a call. | Required | Permitted value:
Note: Recording
operation will be filled with default
value 0 if you leave this field
empty.
|
0 |
All Busy Mode for Endpoints | Whether to forward a new incoming call to the Busy destination when one of the endpoints with extension registered is busy in a call. | Required | Permitted value:
Note: All Busy Mode for Endpoints
will be filled with default value 0
if you leave this field empty.
|
0 |
All Reject Mode for Endpoints | Whether to stop the incoming call from ringing other endpoints and forward to the Busy destination when it was rejected on an endpoint. | Required | Permitted value:
Note: All Reject Mode for
Endpoints will be filled with default
value 0 if you leave this field
empty.
|
0 |
Call Popup URL | Whether to automatically open a custom URL (web page) upon receiving an incoming call. | Required | Permitted value:
Note: Call Popup URL will be filled
with default value 0 if you leave
this field empty.
|
0 |
Popup URL | The address of third-party URL, followed by the variables that you want to pass. | Required if Call Popup URL = 1 | The maximum character length is 255. | http://example.com/somepage.php?number={{.CallerNumber}}&name={{.CallerDisplayName}} |
Communication type | The types of calls that will trigger the call popup. | Required if Call Popup URL = 1 | Permitted value: Internal and
Inbound.
|
Inbound |
Trigger Event | When the call popup will be automatically triggered. | Required if Call Popup URL = 1 | Permitted value: Ringing,
Answered, and Call End. Note: Trigger Event will be filled
with default value Ringing if you
leave the field empty.
|
Ringing |
Allow Being Monitored | Whether to allow the user's calls to be monitored. | Required | Permitted value:
Note: Allow Being
Monitored will be filled with default
value 1 if you leave this field
empty.
|
1 |
Video Preview | Whether to allow other extension users to click a specific button to preview the extension's video when receiving a call from the extension. | Optional | Permitted value:
Note: Video
Preview will be filled with default
value 0 if you leave this field
empty.
|
0 |
Auto Preview | Whether to allow other extension users to automatically preview the extension's video when receiving a call from the extension. | Optional | Permitted value:
Note: Auto
Preview will be filled with default
value 0 if you leave this field
empty.
|
0 |
Hot Desking | Whether to allow the extension to log in to a hot desking phone. | Optional | Permitted value:
Note: Hot
Desking will be filled with default
value 0 if you leave this field
empty.
|
0 |
Log out of Queue | Whether to automatically log out the dynamic agent from the queue when the user log out of a hot desking phone. | Optional | Permitted value:
Note: Log out of
Queue will be filled with default value
0 if you leave this field
empty.
|
0 |
Automatic Guest Out | Whether to automatically log out the extension from a hot desking phone. | Optional |
Permitted value:
Note: Automatic Guest
Out will be filled with default value
0 if you leave this field empty. |
0 |
After hr. | The hour of the specified time period for automatically logging out the extension from a hot desking phone. | Required if Automatic Guest Out = 1 |
Permitted value: 00 - 23 Note: After hr.
will be filled with default value
08 if
you leave this field empty. |
08 |
After min. | The minute of the specified time period for automatically logging out the extension from a hot desking phone. | Required if Automatic Guest Out = 1 |
Permitted value: 00 - 59 Note: After
min. will be filled with default value
00 if you leave this field
empty. |
00 |
At Daily | The time for automatically logging out the extension from a hot desking phone on a daily basis. | Required if Automatic Guest Out = 2 |
Time Format: HH:MM (e.g. 13:30) Note: The End Time must be later than
the Start Time.
|
N/A |
DTMF Mode | The mode for sending DTMF tones. | Required | Permitted value: rfc4733,
info, inband or
auto. Note: DTMF
Mode will be filled with default value
rfc4733 if you leave this field
empty. |
rfc4733 |
Transport | The protocol for transport. | Required | Permitted value: udp,
tcp, or
tls. Note: Transport
will be filled with default value udp if
you leave these fields empty. |
udp |
Qualify | Whether to send the SIP OPTIONS packet periodically to the SIP device to check if the device is online. | Required | Permitted value:
Note: Qualify will be filled with
default value 1 if you leave this
field empty.
|
1 |
T.38 Support | Whether to support T.38 fax for this extension. | Required | Permitted value:
Note: T.38 Support will be filled
with default value
0 if you leave this
field empty. |
0 |
SRTP | Whether to encrypt RTP packets. | Required | Permitted value:
Note: SRTP will be filled with
default value 0 if you leave this
field empty.
|
0 |
Disable Outbound Calls | Whether to restrict the user from making outbound calls. | Required | Permitted value:
Note: Disable Outbound Calls will be
filled with default value 0 if you
leave this field empty.
|
0 |
Disable Outbound Calls outside Business Hours | Whether to restrict the user from making outbound calls outside business hours. | Required | Permitted value:
Note: Disable Outbound Calls outside Business
Hours will be filled with default value
0 if you leave this field
empty. |
0 |
Disallow International Calls | Whether to restrict the user from making international calls. | Required | Permitted value:
Note: Disable International Calls
will be filled with default value 1 if
you leave this field empty. |
1 |
Outbound Route Permission | Specify the outbound routes that this extension is allowed to use. | Optional |
Permitted value: one or more outbound route names existed in PBX. Note:
|
N/A |
Max Outbound Call Duration (s) | The maximum call duration in seconds for making outbound calls from this extension. | Required | Only numbers are allowed. Specially, -1 means follow system and 0 means unlimited. The maximum character length is 7. Note: Max Outbound Call Duration
(s) will be filled with default value
-1 if you leave these fields
empty. |
-1 |
Outbound Call Frequency Restriction | The restriction rule(s) that used to limit the extension outbound call frequency within specified time period. | Optional |
Permitted value: One or more Outbound Call Frequency Restriction names existed in PBX. Note:
|
Default_Ext_Outbound Call Frequency |
Linkus Mobile Client | Whether to allow the extension user to log in to Linkus Mobile Client. | Required | Permitted value:
Note: Linkus Mobile Client will be
filled with default value 1 if you
leave this field empty.
|
1 |
Call Waiting (for Mobile Client) | Whether to receive another call while the extension user is on the phone. | Optional | Permitted value:
Note: Call Waiting (for
Mobile Client) will be filled with
default value 1 if you leave this
field empty.
|
1 |
Auto Answer (for Mobile Client) | Whether to automatically answer non-paging/intercom calls. | Required | Permitted value:
Note: Auto Answer (for
Mobile Client) will be filled with
default value 0 if you leave this
field empty.
|
0 |
Auto Answer Delay Time(s) (for Mobile Client) |
The delay time in seconds before automatically answering non-paging/intercom calls. |
Required if Auto Answer (for Mobile Client) = 1 | Only numbers are allowed. The maximum allowed input is 60. Note: Auto Answer
Delay Time(s) (for Mobile Client) will be
filled with default value 0 if you leave
this field empty. |
0 |
Play Auto Answer Tone (for Mobile Client) | Whether to play a tone to alert the extension user when non-paging/intercom calls are auto answered. | Optional | Permitted value:
Note: Play Auto Answer Tone
(for Mobile Client) will be filled with
default value 1 if you leave this
field empty.
|
1 |
Auto Answer Paging/Intercom Call (for Mobile Client) | Whether to automatically answer paging/intercom calls. | Required | Permitted value:
Note: Auto Answer
Paging/Intercom Call (for Mobile Client)
will be filled with default value 0
if you leave this field empty.
|
0 |
Paging/Intercom Barge (for Mobile Client) | Whether to automatically answer the paging/intercom call when the extension user is already on the phone. | Optional | Permitted value:
Note: Paging/Intercom Barge
(for Mobile Client) will be filled with
default value 0 if you leave this
field empty.
|
0 |
Play Auto Answer Tone for Paging/Intercom Call (for Mobile Client) | Whether to play a tone to alert the extension user when paging/intercom calls are auto answered. | Optional | Permitted value:
Note: Play Auto Answer Tone
for Paging/Intercom Call (for Mobile
Client) will be filled with default
value 1 if you leave this field
empty.
|
1 |
Linkus Desktop Client | Whether to allow the extension user to log in to Linkus Desktop Client. | Required | Permitted value:
Note: Linkus Desktop Client will be
filled with default value 1 if you
leave this field empty.
|
1 |
Call Waiting (for Desktop Client) | Whether to receive another call while the extension user is on the phone. | Optional | Permitted value:
Note: Call Waiting (for
Desktop Client) will be filled with
default value 1 if you leave this
field empty.
|
1 |
Auto Answer (for Desktop Client) | Whether to automatically answer non-paging/intercom calls. | Required | Permitted value:
Note: Auto Answer (for
Desktop Client) will be filled with
default value 0 if you leave this
field empty.
|
0 |
Auto Answer Delay Time(s) (for Desktop Client) |
The delay time in seconds before automatically answering non-paging/intercom calls. |
Required if Auto Answer (for Desktop Client) = 1 | Only numbers are allowed. The maximum allowed input is 60. Note: Auto Answer
Delay Time(s) (for Desktop Client) will be
filled with default value 0 if you leave
this field empty. |
0 |
Play Auto Answer Tone (for Desktop Client) | Whether to play a tone to alert the extension user when non-paging/intercom calls are auto answered. | Optional | Permitted value:
Note: Play Auto Answer Tone
(for Desktop Client) will be filled with
default value 1 if you leave this
field empty.
|
1 |
Auto Answer Paging/Intercom Call (for Desktop Client) | Whether to automatically answer paging/intercom calls. | Required | Permitted value:
Note: Auto Answer
Paging/Intercom Call (for Desktop
Client) will be filled with default
value 0 if you leave this field
empty.
|
0 |
Paging/Intercom Barge (for Desktop Client) | Whether to automatically answer the paging/intercom call when the extension user is already on the phone. | Optional | Permitted value:
Note: Paging/Intercom Barge
(for Desktop Client) will be filled with
default value 0 if you leave this
field empty.
|
0 |
Play Auto Answer Tone for Paging/Intercom Call (for Desktop Client) | Whether to play a tone to alert the extension user when paging/intercom calls are auto answered. | Optional | Permitted value:
Note: Play Auto Answer Tone
for Paging/Intercom Call (for Desktop
Client) will be filled with default
value 1 if you leave this field
empty.
|
1 |
Linkus Web Client | Whether to allow the extension user to log in to Linkus Web Client. | Required | Permitted value:
Note: Linkus Web Client will be
filled with default value 1 if you
leave this field empty.
|
1 |
Call Waiting (for Web Client) | Whether to receive another call while the extension user is on the phone. | Optional | Permitted value:
Note: Call Waiting (for Web
Client) will be filled with default
value 1 if you leave this field
empty.
|
1 |
Auto Answer (for Web Client) | Whether to automatically answer non-paging/intercom calls. | Required | Permitted value:
Note: Auto Answer (for Web
Client) will be filled with default
value 0 if you leave this field
empty.
|
0 |
Auto Answer Delay Time(s) (for Web Client) |
The delay time in seconds before automatically answering non-paging/intercom calls. |
Required if Auto Answer (for Web Client) = 1 | Only numbers are allowed. The maximum allowed input is 60. Note: Auto Answer
Delay Time(s) (for Web Client) will be
filled with default value 0 if you leave
this field empty. |
0 |
Play Auto Answer Tone (for Web Client) | Whether to play a tone to alert the extension user when non-paging/intercom calls are auto answered. | Optional | Permitted value:
Note: Play Auto Answer Tone
(for Web Client) will be filled with
default value 1 if you leave this
field empty.
|
1 |
Auto Answer Paging/Intercom Call (for Web Client) | Whether to automatically answer paging/intercom calls. | Required | Permitted value:
Note: Auto Answer
Paging/Intercom Call (for Web Client)
will be filled with default value 0
if you leave this field empty.
|
0 |
Paging/Intercom Barge (for Web Client) | Whether to automatically answer the paging/intercom call when the extension user is already on the phone. | Optional | Permitted value:
Note: Paging/Intercom Barge
(for Web Client) will be filled with
default value 0 if you leave this
field empty.
|
0 |
Play Auto Answer Tone for Paging/Intercom Call (for Web Client) | Whether to play a tone to alert the extension user when paging/intercom calls are auto answered. | Optional | Permitted value:
Note: Play Auto Answer Tone
for Paging/Intercom Call (for Web
Client) will be filled with default
value 1 if you leave this field
empty.
|
1 |
Linkus Pad Client (SDK) | Whether to allow the extension user to log in to Linkus Pad Client (SDK). | Required | Permitted value:
Note:
|
1 |
Linkus Mobile Client Codec | Specify the audio codec for this user's Linkus Mobile Client. | Optional | Permitted value:
|
N/A |