PBX GUI - Bulk Extensions Module User Guide

PBX GUI - Bulk Extensions Module User Guide

 

In FreePBX 13, this module is deprecated in favor of Bulk Handler. The two modules are not compatible. Please use Bulk Handler with FreePBX 13+.

Overview

The Bulk Extension module allows you to easily import all your extensions from a CSV. This will save you time if you need to create a large number of extensions on the system.

Bulk extension changes can take a long time to complete. It can take 30-60 seconds to add 100 extensions on a small system. However, on a system with 2,000 extensions, it can take about 5 minutes to add 100 new extensions.

Logging in

  • From the top menu click Applications

  • In the drop down click Bulk Extensions

Exporting Extensions

  • You can choose to export all your existing extensions to CSV. This will allow you to modify anything on each extension and re-import them.

  • Pressing the “Export Extensions” button on the main page should allow you to download the CSV of all your current extensions.

  • You can now open this file in a CSV-friendly program, like Microsoft Excel, and make changes or add new entries.

 

Bulk Extensions CSV File Columns

The table below explains each column in the CSV file. You can change the column order of the CSV file as you like, however, the column names must be preserved.

#

Name

Default

Allowed

On Extensions page

Details

#

Name

Default

Allowed

On Extensions page

Details

1

action

 

add, del, edit

 

Add, Delete, or Edit an Extension.

2

extension

 

 

User Extension

The extension number to dial to reach this user.

3

name

 

 

Display Name

The caller id name for calls from this user will be set to this name. Only enter the name, NOT the number.

4

cid_masquerade

 

 

CID Num Alias

The CID Number to use for internal calls

5

sipname

 

 

SIP Alias

If you want to support direct sip dialing of users internally or through anonymous sip calls, you can supply a friendly name that can be used in addition to the user's extension to call them.

6

outboundcid

 

 

Outbound CID

Overrides the caller id when dialing out a trunk. Any setting here will override the common outbound caller id set in the Trunks admin.

Format: "caller name" <#######>

Leave this field blank to disable the outbound CallerID feature for this user.

7

ringtimer

0

0-120

Ring Time

Number of seconds to ring prior to going to Voicemail. 0 (Default) will use the value set in the General Tab. If no Voicemail is configured this will be ignored.

8

callwaiting

enabled

enabled, disabled

Call Waiting

Set the initial/current Call Waiting state for this user's extension.

9

call_screen

0

0, nomemory, memory

Call Screening

Call Screening requires external callers to say their name, which will be played back to the user and allow the user to accept or reject the call. Screening with memory only verifies a caller for their caller-id once. Screening without memory always requires a caller to say their name. Either mode will always announce the caller based on the last introduction saved with that CallerID. If any user on the system uses the memory option, when that user is called, the caller will be required to re-introduce themselves and all users on the system will have that new introduction associated with the caller's CallerID.Set the initial/current Call Waiting state for this user's extension.

10

pinless

 

enabled, disabled

Pinless Dialing"

Enabling Pinless Dialing will allow this extension to bypass any pin codes normally required on outbound calls

11

password

 

 

 

For logging in and out of devices in deviceanduser mode, not available on Extensions page.

12

noanswer_dest

 

Text in the format context,exten,priority that is an active dialplan destination on the system

Optional Destinations, No Answer (Extensions page)

Optional: Setting a destination here where to send the call if the called extension was not answered

13

noanswer_cid

 

 

Optional Destinations, CID Prefix (Extensions page)

You can optionally prefix the Caller ID name when sending the call to the above destination. ie: If you prefix with 'No Answer:', a call to John Doe that was not answered would display as 'No Answer:John Doe' on the extensions belonging to the destination selected

14

busy_dest

 

Text in the format context,exten,priority that is an active dialplan destination on the system

Optional Destinations, Busy (Extensions page)

Optional: Setting a destination here where to send the call if the extension was busy

15

busy_cid

 

 

Optional Destinations, CID Prefix (Extensions page)

You can optionally prefix the Caller ID name when sending the call to the above destination. ie: If you prefix with 'Busy:', a call to John Doe that was busy would display as 'Busy:John Doe' on the extensions belonging to the destination selected

16

chanunavail_dest

 

Text in the format context,exten,priority that is an active dialplan destination on the system

Optional Destinations, Not Reachable (Extensions page)

Optional: Setting a destination here where to send the call if the extension was not reached

17

chanunavail_cid

 

 

Optional Destinations, CID Prefix (Extensions page)

You can optionally prefix the Caller ID name when sending the call to the above destination. ie: If you prefix with 'Not Reached:', a call to John Doe that was busy would display as 'Not Reached:John Doe' on the extensions belonging to the destination selected

18

emergency_cid

 

 

Emergency CID

This caller id will always be set when dialing out an Outbound Route flagged as Emergency. The Emergency CID overrides all other caller id settings.

19

tech

 

sip, iax2, zap, custom

 

Device channel type.

20

hardware

 

generic, custom, (can leave blank)

 

 

21

devinfo_channel

 

 

channel

See zapata.conf.

22

devinfo_secret

 

 

secret

See sip.conf file or iax.conf file.

23

devinfo_notransfer

yes

 

notransfer

See iax.conf file.

24

devinfo_dtmfmode

rfc2833

 

dtmfmode

See sip.conf file.

25

devinfo_canreinvite

no

 

canreinvite

See sip.conf file.

26

devinfo_context

from-internal

 

context

Device context.

27

devinfo_immediate

no

 

immediate

See zapata.conf file.

28

devinfo_signalling

fxo_ks

 

signalling

See zapata.conf file.

29

devinfo_echocancel

yes

 

echocancel

See zapata.conf file.

30

devinfo_echocancelwhenbridged

no

 

echocancelwhenbridged

See zapata.conf file.

31

devinfo_echotraining

800

 

echotraining

See zapata.conf file.

32

devinfo_busydetect

no

 

busydetect

See zapata.conf file.

33

devinfo_busycount

7

 

busycount

See zapata.conf file.

34

devinfo_callprogress

no

 

callprogress

See zapata.conf file.

35

devinfo_host

dynamic

 

host

See sip.conf file or iax.conf file.

36

devinfo_type

friend

 

type

See sip.conf file or iax.conf file.

37

devinfo_nat

yes

 

nat

See sip.conf file.

38

devinfo_port

 

 

port

See sip.conf file or iax.conf file. Default for sip is 5060, iax2 is 4569.

39

devinfo_qualify

yes

 

qualify

See sip.conf file or iax.conf file.

40

devinfo_callgroup

 

 

callgroup

See sip.conf file.

41

devinfo_pickupgroup

 

 

pickupgroup

See sip.conf file.

42

devinfo_disallow

 

 

disallow

See conf file for device tech. Codec(s) to disallow.

43

devinfo_allow

 

 

allow

See conf file for device tech. Codec(s) to allow.

44

devinfo_dial

 

 

dial

See conf file for device tech. Default is TECH/exten, i.e SIP/101. For zap it is TECH/channel, i.e. ZAP/1.

45

devinfo_accountcode

 

 

accountcode

See conf file for device tech.

46

devinfo_mailbox

 

 

mailbox

See conf file for device tech. Default is exten@device, i.e 101@device.

47

devinfo_deny

 

 

deny

Network/Mask of IP address range to deny. Default is 0.0.0.0/0.0.0.0 (or everything).

48

devinfo_permit

 

 

permit

Network/Mask of IP address range to permit. Default is 0.0.0.0/0.0.0.0 (or everything). Valid examples would be: 192.168.1.0/255.255.255.0 (all IP addresses from 192.168.1.0-255) or 10.1.0.42/255.255.255.255 (a single address).

49

devicetype

fixed

fixed, adhoc

 

Extensions require that devicetype be fixed. If devicetype is adhoc, FreePBX must manage it in Device and Users mode, not Extensions mode.

50

deviceid

 

 

 

Defaults to be the value of extension (see item 2 of this table).

51

deviceuser

 

 

 

Fixed devices will always be mapped to this user. Adhoc devices will be mapped to this user by default.

If selecting 'New User', a new User Extension of the same Device ID will be set as the Default User.

52

description

 

 

 

The caller id name for this device will be set to this description (until it is logged into - possible when adhoc devicetype is used).

53

dictenabled

disabled

enabled, disabled

Dictation Service

 

54

dictformat

ogg

ogg, gsm, wav

Dictation Format

 

55

dictemail

 

 

Email Address

The email address that completed dictations are sent to.

56

langcode

 

 

Language Code

The language code for this user. This will result in messages such as voiclangcode prompts to use the selected language if installed.

57

vm

disabled

enabled, disabled

Status

Set Voicemail status for this user.

58

vmpwd

 

 

Voicemail Password

This is the password used to access the Voicemail system.

This password can only contain numbers.

A user can change the password you enter here after logging into the Voicemail system (*98) with a phone.

59

email

 

 

Email Address

The email address that Voicemails are sent to.

60

pager

 

 

Pager Email Address

Pager/mobile email address to which short Voicemail notifcations are sent.

61

attach

attach=no

attach=yes, attach=no

Email Attachment

Option to attach Voicemails to email.

62

saycid

saycid=no

saycid=yes, saycid=no

Play CID

Read back caller's telephone number prior to playing the incoming message, and just after announcing the date and time the message was left.

63

envelope

envelope=no

envelope=yes, envelope=no

Play Envelope

Envelope controls whether or not the Voicemail system will play the message envelope (date/time) before playing the Voicemail message. This settng does not affect the operation of the envelope option in the advanced Voicemail menu.

64

delete

delete=no

delete=yes, delete=no

Delete Vmail

If set to "yes" the message will be deleted from the Voicemailbox (after having been emailed). Provides functionality that allows a user to receive their Voicemail via email alone, rather than having the Voicemail able to be retrieved from the Web interface or the Extension handset. CAUTION: MUST HAVE attach Voicemail to email SET TO YES OTHERWISE YOUR MESSAGES WILL BE LOST FOREVER.

65

options

 

 

VM Options

Separate options with pipe ( | ) 

ie: review=yes|maxmessage=60

66

vmcontext

default

 

VM Context

This is the Voicemail Context which is normally set to default. Do not change unless you understand the implications.

67

vmx_state

 

checked, (leave blank to disable)

VmX Locater™

Enable/Disable the VmX Locater feature for this user. When enabled all settings are controlled by the user in the User Portal (ARI). Disabling will not delete any existing user settings but will disable access to the feature

68

vmx_unavail_enabled

 

checked, (leave blank to disable)

Use When: unavailable

 

69

vmx_busy_enabled

 

checked, (leave blank to disable)

Use When: busy

 

70

vmx_play_instructions

 

checked, (leave blank to disable)

Voicemail Instructions: Standard Voicemail prompts.

Uncheck to play a beep after your personal Voicemail greeting.

71

vmx_option_0_system_default

 

checked, (leave blank to disable)

Go To Operator

Pressing 0 during your personal Voicemail greeting goes to the Operator. Uncheck to enter another destination here. This feature can be used while still disabling VmX to allow an alternative Operator extension without requiring the VmX feature for the user.

72

vmx_option_0_number

 

 

Press 0:

Pressing 0 during your personal Voicemail greeting goes to the Operator. Uncheck to enter another destination here. This feature can be used while still disabling VmX to allow an alternative Operator extension without requiring the VmX feature for the user.

73

vmx_option_1_system_default

 

checked, (leave blank to disable)

 

 

74

vmx_option_1_number