Brekeke PBX Wiki

6. Extension Settings Properties

The tables below contain the property names that may be viewed or altered using the WebSocket methods. These lists are not comprehensive:

 

 

1. Callback Extension
Property Name Description Value
type Extension type callback
callback.callee Callback callee Extension number
desc Description Text
noanswerforward Forwarding destination

(No answer)

Extension number
ringertime Ringer time Number

 

2. Conference Extension
Property Name Description Value
type Extension type conference
callback.callee Callback callee Extension number
conf.accept Applied to (Caller numbers) Wildcard pattern
desc Description Text
exit.on.host.disconnected Exit all when host leaves true or false
phoneforward Forwarding destinations Comma-separated extension numbers

 

3. Groups Extension

Simultaneous Ring

Property Name Description Value
type Extension type ringgroup
stype Specific type sr
desc Description Text
noanswerforward Forwarding destination

(No answer)

Extension number
phoneforward Forwarding destinations Comma-separated extension numbers
ringertime Ringer time Number

Call Hunting

Property Name Description Value
type Extension type ringgroup
stype Specific type rr
desc Description Text
noanswerforward Forwarding destination

(No answer)

Extension number
switchmode Mode – cyclic

– ascending

phoneforward Hunt group extensions Comma-separated extension numbers
queuingcallinterval Call interval (msec) Number
queuingmax Max number of calls in the queue Number
queuingtime Waiting time in the queue Number
ringertimes Ringer time Numbers separated by comma
round.tryonce Single attempt true or false

 

4. IVR Extension

Auto Attendant

Property Name Description Value
type Extension type ivr
stype Specific type aa
desc Description Text
ex.autotransfer Default operator User extension
ex.calltimesec Ring timeout (sec) Number
ex.digitmaxlength Max input digits Number
ex.dtmfwaittimesec DTMF timeout (sec) Number
ex.maxretry Max retry count Number
ex.speeddial Speed dial
ex.useronly Transfer to unregistered users true or false
language Language en or ja

 

 

Add/Remove Forwarding Destinations

Property Name Description Value
type Extension type ivr
stype Specific type fm
desc Description Text
language Language en or ja
fm.targetusers Target groups Group extension numbers, separated by commas

 

Switch Plan

Property Name Description Value
type Extension type ivr
stype Specific type ptn
desc Description Text
language Language en or ja
ptn.index Plan number Plan number
ptn.toggle On/Off true or false

 

Script

Property Name Description Value
type Extension type ivr
stype Specific type scr
desc Description Text
ivr.script.autoanswer Auto Answer true or false
ivr.script.function Function name Text
ivr.script.note Note name Text
ivr.script.parameter Parameter
language Language en or ja

 

Flow

Property Name Description Value
type Extension type ivr
stype Specific type fl
desc Description Text
ivr.flow.autoanswer Auto Answer true or false
ivr.flow.name Flow name Text
ivr.flow.parameter Properties
language Language en or ja

 

5. Schedule Extension
Property Name Description Value
type Extension type conditional
desc Description Text
pln[n]_d_noanswerforward Plan[n] default Forwarding Schedule Call Forwarding destination Extension number
pln[n]_d_p[n]_paging Plan[n] phone[n] default paging true or false
pln[n]_ptn[n]_callerroute Route selection – any

– external

– internal

pln[n]_ptn[n]_filtertext Plan[n] Forwarding Schedule[n] Filter setting Regular expression
pln[n]_ptn[n]_filtertype Plan[n] Forwarding Schedule[n] Filter match radio box match or unmatch
pln[n]_ptn[n]_timeschedule Plan[n] Forwarding Schedule[n] time schedule setup Format:

P<start-end-date>A<days-of-week>W<weeks>D<date-pattern>T<times>

 

Sample setup:

– P<start-end-date>

Pyyyymmddyyyymmdd

– T<times>

Thhmmhhmmhhmmhhmm

– D<date-pattern>

[Include] or [Exclude] days separated by comma

– A<days-of-week> and

W<weeks>

Decimal value equals the binary number represented by bit flag of selected fields. Right side holds higher-value digit.

pln[n]_ptn[n]_noanswerforward Plan[n] Forwarding Schedule[n] Call Forwarding destination Extension number
pln[n]_ptn[n]_p[n]_paging Plan[n] Forwarding Schedule[n] phone[n] paging true or false

 

6. User extension
Property Name Description Value
admin If an admin user true or false
allowjoin Allow others to join my conversation true or false
automonitor Automatic Monitoring Comma-separated user extensions
busyforward.voicemail If forward call to voicemail when user is busy true or false
canjoin Join other’s conversation true or false
defaultpickup Call pickup group A group extension number
desc User description Text
email Email address Email addresses where voicemails will be forwarded, separated by comma
emailattachment Attach WAV file to email true or false
emailnotification Enable email notification or not true or false
greetingtype Greeting message 1 = Personal

2 = Alternative

3 = Default System

language Language en or ja
login.password User login password Text
maxsessioncount Max inbound sessions -1 means unlimited, or 0 thru 6
messageforward Message forwarding A list of user extensions, separated by comma
name Display name of this user Text
noanswerforward.voicemail If forward call to user voicemail when user does not answer the call true or false
password User voicemail box password Text
pln[n]_d_anothercall.beep Beep on Incoming Call true or false
pln[n]_d_busyforward [Call Forwarding] > [Forwarding Destination (Busy)] Text
pln[n]_d_callnext Call next phone if phone stops ringing true or false
pln[n]_d_knockknock Knock Knock period Number
pln[n]_d_knockknock_onlyinternal Only from internal extension true or false
pln[n]_d_noanswerforward [Call Forwarding] > [Forwarding Destination (No answer)] Text
pln[n]_d_phoneforward [Call Forwarding] > [Other Forwarding Destinations] Comma-separated list of phone numbers
pln[n]_d_ringertime [Call Forwarding] > [Ringer time (sec)] Number
pln[n]_d_p[n]_delay Plan[n] phone[n] [Delay (sec)] setting Number
pln[n]_d_p[n]_enabled If enabled, plan[n] phone[n] true or false
pln[n]_d_p[n]_paging Plan[n] phone[n] default paging true or false
pln[n]_d_p[n]_ringertime Plan[n] phone[n] ringer time Number
pnumber[n] Phone[n] ID Text
p[n]_ptype Phone[n] Type Phone type set at [Options] > [Phone Type]
recording Call Recording True or false
recording.pattern Call Recording Patterns Comma-separated list of patterns
recordlength Message recording length Number
resourcemap Resource map Text
type User type User
userclass User class User class options set in [Options] > [User Access Settings]
voicemail.readcallerid Talking caller ID true or false
voicemail.password.enter.type Skip password from my phone 0: no

1: yes

 

  • pln[n]_d_xxxx are properties’ names for the user extension [Inbound] page plan [n] Default Forwarding Schedule settings.
  • pln[n]_ptn[n]_xxxx are properties’ names for the user extension [Inbound] page plan [n] Forwarding Schedule [n] settings.
  • User Forwarding Schedule [n] properties’ names are the same as those in Default Forwarding Schedule settings, but with a different prefix. For the Forwarding Schedule [n] Conditions properties’ names, please check the Schedule Extension table.
Yes No
Suggest Edit