Tenants

Supported methods:

Methods	Description
list	Returns the list of existing tenants
configuration	Returns the configuration of a tenant
add	Allows you to add a tenant
edit	Allows you to edit a tenant
delete	Allows you to delete a tenant
trunks.list	Returns the list of trunks available for a tenant
trunks.set	Allows you to edit the trunks assigned to a tenant

{ "2": { "name": "t1.dot.com", "tenantcode": "344", "package_id": "1", "package": "Package 1", "ext_length": 3, "country_id": "869", "country_code": "1", }, "7": { "name": "t2.dot.com", "tenantcode": "454", "package_id": "2", "package": "Package 2", "ext_length": 3, "country_id": "869", "country_code": "1", } }

PARAMS
apikey	API key generated on your PBXware
action	pbxware.tenants.configuration Action with methods to retrieve the requested value(s)
tenant_name	Tenant name (Required)
tenant_code	Unique 3-digit tenant code (Required)
package	Tenant package ID (Required)
ext_length	Extension length (Required)
country	Country ID (Required)
area_code	Area code (Required)
national	National code (Required)
international	International code (Required)
glocom_dns_srv_lookup	Use DNS SRV lookup for gloCOM
glocomproxy	SIP Proxy for gloCOM
apusername	HTTP Username
appassword	HTTP password
defaultserver	Default server
announcetrunks	Announce trunks
absolutetimeout	Absolute delay
cdrvoicemail	Voicemail in CDRs
faxformat	FAX page format
faxfiletype	FAX file type
enabletcalls	Enable tenant-to-tenant calls
disabletcid	Disable caller ID rewriting for tenant-to-tenant calls
tenantcid	Default caller ID
tenant_faxcid	Default FAX caller ID
usedefaultcid	Use the default caller ID for tenant-to-tenant calls
usedidcid	Use DIDs as caller ID for tenant-to-tenant calls
finde164	Find E.164 numbers in DIDs
recordlimit	Number of objects per page (Default: 10)
showdirosc	Show the directory in OSC
recordglobal	Record calls by default
recordsilent	Default silent recording
mp3_auto_conv	Convert recordings to mp3 during generation
recordbeep	Play a periodic beep
recordformat	Recording format
audiolang	Audio language
cpark_timeout	Enhanced call parking delay (in seconds)
cpark_dial	Enhanced call parking announcement
cpark_goto	Enhanced call park timeout extension
limitsound	Play a sound
limitemail	International code (Required)
notifyemail	International code (Required)
leavenational	Leave National Code
currency	Currency symbol / ISO code
currencypos	Currency writing convention
dialed_num_minimum_length	Minimum length of the dialed number
pstn_mode	PSTN dialing mode
callgroups	Call groups / Pickup groups (separated by commas)
incominglimit	Local channels
outgoinglimit	Remote channels
conch	Conference channels
quech	Queue channels
ergch	Enhanced ring group channels
aach	Auto attendant channels
zapch	DAHDI channels
localcodecs	Local codecs
remotecodecs	Remote codecs
networkcodecs	Network codecs
hdcheck	Checking login attempts
hdlockext	Lock the extension after X failed attempts
hdlockdevice	Lock the phone after X locked extensions
hdautologout	Automatic logout
hdlogoutinactive	Logout after X hours of inactivity
ringtonelocal	Ringtone for local calls
hidecallerid	Hide caller ID in OSC
allowescallerid	Allow « ES CallerID » for call forwarding
enablecnamlookup	Enable caller ID CNAM lookup
setcidforgrouphunt	Set the caller ID for hunt group calls
cidmatchdid	Allow only the trunk caller ID within the DID range
dropanonymous	Reject anonymous calls
didsaveupdatecid	On DID record, update ES/CID/Trunks
forceunknown	Do not allow users to send any Caller ID
hideextnodir	Hide extensions with no department (gloCOM)
custompresencetime	gloCOM offline presence delay (minutes)
usedynfeatures	Use dynamic features
nobillingfwd (deprecated and will soon be replaced by cf_call_rating_disable)	Disable billing for call forwarding (deprecated and will soon be replaced by cf_call_rating_disable)
cf_call_rating_disable	Disable call rating for call forwarding

PARAMS
apikey	API key generated on your PBXware
action	pbxware.tenants.add Action with methods to retrieve the requested value(s)
tenant_name	Tenant name (Required)	Must be a valid FQDN (Fully Qualified Domain Name)
tenant_code	Unique 3-digit tenant code (Required)
package	Tenant package ID (Required)	Can be obtained with the package object
ext_length	Extension length (Required)	Can be in the range 2-16 ONLY
country	Country ID (Required)	Can be obtained with the route object
area_code	Regional code
national	National code (Required)
international	International code (Required)
glocom_dns_srv_lookup	Use gloCOM DNS SRV lookup
glocomproxy	gloCOM SIP Proxy
apusername	HTTP Username
appassword	HTTP password
defaultserver	Default server
announcetrunks	Announce trunks
absolutetimeout	Absolute delay
cdrvoicemail	Voicemail in CDRs	2: As Voicemail, 1: As missed calls, 0: As answered calls
faxformat	FAX page format	letter, legal, A4, auto
faxfiletype	FAX file type	1: PDF and TIFF, 2: PDF only, 3: TIFF only
default_location	Default extension location (Local=1, Remote=2)
enabletcalls	Enable inter-tenant calls
disabletcid	Disable caller ID rewriting for inter-tenant calls
tenantcid	Default caller ID
tenant_faxcid	Default caller ID for fax
usedefaultcid	Use the default caller ID for calls between tenants
usedidcid	Use DIDs as caller ID for calls between tenants
finde164	Find E.164 numbers in DIDs
recordlimit	Number of objects per page (Default: 10)
showdirosc	Show the directory in the OSC
recordglobal	Record calls by default
recordsilent	Default silent recording
mp3_auto_conv	Convert recordings to mp3 upon generation
recordbeep	Play periodic beep
recordformat	Recording format	gsm: GSM, wav: WAV, wav49: WAV49, g729: native G729, ogg: OGG
audiolang	Audio language
cpark_timeout	Enhanced call parking delay (in seconds)
cpark_dial	Enhanced call parking announcement extension
cpark_goto	Enhanced call parking timeout extension
limitsound	Play a sound
limitemail	International code (Required)
notifyemail	International code (Required)
leavenational	Leave National Code
currency	Currency symbol/ISO code
currencypos	Currency writing convention	left: Symbol before the amount, right: Symbol after the amount
dialed_num_minimum_length	Minimum length of the dialed number
pstn_mode	PSTN dialing mode
callgroups	Call groups/Pickup groups (separated by commas)
localcodecs	Local codecs
remotecodecs	Remote codecs
networkcodecs	Network codecs
hdcheck	Checking login attempts
hdlockext	Lock the extension after X failed attempts
hdlockdevice	Lock the phone after X locked extensions
hdautologout	Automatic logout
hdlogoutinactive	Logout after X hours of inactivity
ringtonelocal	Ringtone for local calls
hidecallerid	Hide caller ID in OSC
allowescallerid	Allow ES caller ID for call forwarding
enablecnamlookup	Enable CNAM lookup for the caller ID
setcidforgrouphunt	Set the caller ID for hunt group calls
cidmatchdid	Allow only the trunk caller ID within the DID range
dropanonymous	Reject anonymous calls
didsaveupdatecid	On DID save, update ES/CID/Trunks
forceunknown	Do not allow users to send any Caller ID
hideextnodir	Hide extensions with no department (gloCOM)
custompresencetime	gloCOM offline presence delay (in minutes)
usedynfeatures	Use dynamic features
nobillingfwd	Disable billing for call forwarding	(deprecated and will soon be replaced by cf_call_rating_disable)
cf_call_rating_disable	Disable call rating
jbimpl	Jitter buffer	inherit, disabled, fixed, adaptive
jbmaxsize	Maximum size (ms)
jbresyncthreshold	Resynchronization threshold
jbtargetextra	Extra target
allowextipauth	Allow IP address authentication for extensions	Yes=1, No=0
voiceskippin	Skip the PIN request for voicemail	Yes=1, No=0
email_from	From the email
vm_email_from	From the voicemail email
local_channels	Local channels
remote_channels	Remote channels
conferences	Conferences
queues	Queues
auto_attendants	Auto attendants
dahdi	DAHDI
dids_notify_email	Notification email
dids_notify_order	Sort by
es_ambulance	Ambulance
es_fire	Fire
es_police	Font
es_notification_email	Notification email
ldap_enabled	Enable LDAP	Yes=1, No=0
ldap_local_exts	Include system extensions	(Yes=1, No=0, Not set=”)
ldap_hotdesking	Enable LDAP for remote-work devices	(Yes=1, No=0, Not set=”)
ldap_password	LDAP password

PARAMS
apikey	API key generated on your PBXware
action	pbxware.tenants.list Action with methods to retrieve the requested value(s)
tenant	Tenant ID Example: 10
trunks	List of trunk IDs (comma-separated). (Regex: /^[0-9,]+$/)
primary_trunk	Primary trunk (Regex : /^\d{1,10}$/)
secondary_trunk	Secondary trunk (Regex : /^\d{1,10}$/)
tertiary_trunk	Tertiary trunk (Regex : /^\d{1,10}$/)
primary_emerg_trunk	Primary emergency trunk (Regex: /^\d{1,10}$/)
secondary_emerg_trunk	Secondary emergency trunk (Regex: /^\d{1,10}$/)
tertiary_emerg_trunk	Tertiary emergency trunk (Regex: /^\d{1,10}$/)

PARAMS
apikey	API key generated on your PBXware
action	pbxware.tenants.list Action with methods to retrieve the requested value(s)
name	Tenant name
tenantcode	Unique tenant code
package	Package ID
ext_length	Extension digit length
country_id	Tenant country ID
country_code	Tenant country code

tenants.list

tenants.configuration

tenants.add

tenants.edit

tenants.delete

tenants.trunks.list

tenants.trunks.list

tenant.trunks.set

PARAMS
apikey	API key generated on your PBXware
action	pbxware.tenants.edit Action with methods to retrieve the requested value(s)
status	Status (Inactive=0, Active=1, Suspended=2) The other arguments are identical to those in the Adding Tenants section, except for ext_length, which cannot be modified. They are all optional, except for
server	ID of the server, which must be set to 1
id	Tenant ID

PARAMS
apikey	API key generated on your PBXware
action	pbxware.tenants.edit Action with methods to retrieve the requested value(s)
status	Status (Inactive=0, Active=1, Suspended=2) The other arguments are identical to those in the Adding Tenants section, except for ext_length, which cannot be modified. They are all optional, except for
server	ID of the server, which must be set to 1
id	Tenant ID