Tenants

Temps estimé :11 minutes

Méthodes supportées :

Méthodes	Description
list	Retourne la liste des tenants existants
configuration	Retourne la configuration d’un tenant
add	Permet d’ajouter un tenant
edit	Permet d’éditer un tenant
delete	Permet de supprimer un tenant
trunks.list	Retourne la liste des trunks disponible pour un tenant
trunks.set	Permet de modifier les trunks attribués à un tenant

GET

tenants.list

Cet action vous permet de lister tous les tenants existants :

https://wiki.bicomsystems.fr/documentation/premiers-pas/tenants/

				
					http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.tenant.list

PARAMS
apikey	Clé d’API généré sur votre PBXware
action	pbxware.tenants.list Action avec méthodes pour récupérer la ou les valeurs demandées
name	Nom du tenant
tenantcode	Code unique de tenant
package	ID du pack
ext_length	Longueur de chiffres des extensions
country_id	ID de pays du tenant
country_code	Code de pays du tenant

Exemple de requête :

				
					curl --location 'votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.tenant.list'

Exemple de réponse :

				
					{
	"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",
	}
}

GET

tenants.configuration

Cet action vous permet de retourner la configuration d’un tenant en particulier.

https://wiki.bicomsystems.fr/documentation/premiers-pas/tenants/

				
					http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.tenant.configuration&id=10

PARAMS
apikey	Clé d’API généré sur votre PBXware
action	pbxware.tenants.configuration Action avec méthodes pour récupérer la ou les valeurs demandées
tenant_name	Nom du locataire (Requis)
tenant_code	Code locataire unique à 3 chiffres (Requis)
package	Identifiant de package locataire (Requis)
ext_length	Longueur des extensions (Requis)
country	ID pays (Requis)
area_code	Code de zone (Requis)
national	Code national (Requis)
international	Code international (Requis)
glocom_dns_srv_lookup	Utiliser la recherche DNS SRV pour gloCOM
glocomproxy	Proxy SIP pour gloCOM
apusername	Nom d’utilisateur HTTP
appassword	Mot de passe HTTP
defaultserver	Serveur par défaut
announcetrunks	Annoncer les troncs
absolutetimeout	Délai absolu
cdrvoicemail	Messagerie vocale dans les CDR
faxformat	Format de page FAX
faxfiletype	Type de fichier FAX
enabletcalls	Activer les appels locataire à locataire
disabletcid	Désactiver la réécriture de l’ID appelant pour les appels locataire à locataire
tenantcid	ID appelant par défaut
tenant_faxcid	ID appelant FAX par défaut
usedefaultcid	Utiliser l’ID appelant par défaut pour les appels locataire à locataire
usedidcid	Utiliser les DIDs comme ID appelant pour les appels locataire à locataire
finde164	Trouver des numéros E.164 dans les DIDs
recordlimit	Nombre d’objets par page (Par défaut : 10)
showdirosc	Afficher l’annuaire dans OSC
recordglobal	Enregistrer les appels par défaut
recordsilent	Enregistrement silencieux par défaut
mp3_auto_conv	Convertir les enregistrements en mp3 lors de la génération
recordbeep	Jouer un bip périodique
recordformat	Format d’enregistrement
audiolang	Langue audio
cpark_timeout	Délai de stationnement d’appel amélioré (en secondes)
cpark_dial	Annonce de stationnement d’appel amélioré
cpark_goto	Extension de délai de stationnement d’appel amélioré
limitsound	Jouer un son
limitemail	Code international (Requis)
notifyemail	Code international (Requis)
leavenational	Laisser le code national
currency	Symbole de devise / Code ISO
currencypos	Convention d’écriture de la devise
dialed_num_minimum_length	Longueur minimale du numéro composé
pstn_mode	Mode de numérotation PSTN
callgroups	Groupes d’appel / Groupes de capture (séparés par des virgules)
incominglimit	Canaux locaux
outgoinglimit	Canaux distants
conch	Canaux de conférence
quech	Canaux de file d’attente
ergch	Canaux de groupes de sonnerie améliorés
aach	Canaux d’assistants automatiques
zapch	Canaux DAHDI
localcodecs	Codecs locaux
remotecodecs	Codecs distants
networkcodecs	Codecs réseau
hdcheck	Vérification des tentatives de connexion
hdlockext	Verrouiller l’extension après X tentatives échouées
hdlockdevice	Verrouiller le téléphone après X extensions verrouillées
hdautologout	Déconnexion automatique
hdlogoutinactive	Déconnexion après X heures d’inactivité
ringtonelocal	Sonnerie pour les appels locaux
hidecallerid	Masquer l’ID appelant dans OSC
allowescallerid	Autoriser « ES CallerID » pour le renvoi d’appel
enablecnamlookup	Activer la recherche CNAM de l’ID appelant
setcidforgrouphunt	Définir l’ID appelant pour les appels de chasse de groupe
cidmatchdid	Autoriser uniquement l’ID appelant du tronc dans la plage DID
dropanonymous	Rejeter les appels anonymes
didsaveupdatecid	Sur enregistrement DID, mettre à jour ES/CID/Trunks
forceunknown	Ne pas autoriser les utilisateurs à envoyer un ID appelant quelconque
hideextnodir	Masquer les extensions sans département (gloCOM)
custompresencetime	Délai de présence hors ligne de gloCOM (minutes)
usedynfeatures	Utiliser des fonctionnalités dynamiques
nobillingfwd (obsolète et sera bientôt remplacé par cf_call_rating_disable)	Désactiver la facturation pour le renvoi d’appel (obsolète et sera bientôt remplacé par cf_call_rating_disable)
cf_call_rating_disable	Désactiver l’évaluation des appels pour le renvoi d’appel

Exemple de requête :

				
					curl --location 'votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.tenant.configuration&id=10'

GET

tenants.add

Cet action vous permet d’ajouter un nouveau tenant :

https://wiki.bicomsystems.fr/documentation/premiers-pas/tenants/

				
					http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.tenant.add&tenant_name=TestAPI&tenant_code=555&package=&ext_length=&country=&national=&international=

PARAMS
apikey	Clé d’API générée sur votre PBXware
action	pbxware.tenants.add Action avec méthodes pour récupérer la ou les valeurs demandées
tenant_name	Nom du locataire (Requis)	Doit être un FQDN valide (Fully Qualified Domain Name)
tenant_code	Code de locataire unique à 3 chiffres (Requis)
package	ID de package du locataire (Requis)	Peut être obtenu avec l’objet package
ext_length	Longueur des extensions (Requis)	Peut être dans la plage 2-16 UNIQUEMENT
country	ID du pays (Requis)	Peut être obtenu avec l’objet route
area_code	Code régional
national	Code national (Requis)
international	Code international (Requis)
glocom_dns_srv_lookup	Utiliser la recherche DNS SRV gloCOM
glocomproxy	Proxy SIP gloCOM
apusername	Nom d’utilisateur HTTP
appassword	Mot de passe HTTP
defaultserver	Serveur par défaut
announcetrunks	Annoncer les troncs
absolutetimeout	Délai absolu
cdrvoicemail	Boîte vocale dans les CDR	2: Comme Boîte vocale, 1: Comme appels non répondus, 0: Comme appels répondus
faxformat	Format de page FAX	lettre, légal, A4, auto
faxfiletype	Type de fichier FAX	1: PDF et TIFF, 2: Seulement PDF, 3: Seulement TIFF
default_location	Emplacement d’extension par défaut (Local=1, Remote=2)
enabletcalls	Activer les appels entre locataires
disabletcid	Désactiver la réécriture de l’ID de l’appelant pour les appels entre locataires
tenantcid	ID de l’appelant par défaut
tenant_faxcid	ID de l’appelant par défaut pour le fax
usedefaultcid	Utiliser l’ID de l’appelant par défaut pour les appels entre locataires
usedidcid	Utiliser les DIDs comme ID de l’appelant pour les appels entre locataires
finde164	Trouver les numéros E.164 dans les DIDs
recordlimit	Nombre d’objets par page (Par défaut : 10)
showdirosc	Afficher le répertoire dans l’OSC
recordglobal	Enregistrer les appels par défaut
recordsilent	Enregistrement silencieux par défaut
mp3_auto_conv	Convertir les enregistrements en mp3 à la génération
recordbeep	Jouer le bip périodique
recordformat	Format des enregistrements	gsm: GSM, wav: WAV, wav49: WAV49, g729: G729 natif, ogg: OGG
audiolang	Langue audio
cpark_timeout	Délai de stationnement des appels amélioré (en secondes)
cpark_dial	Extension d’annonce du stationnement des appels amélioré
cpark_goto	Extension de délai d’expiration du stationnement des appels amélioré
limitsound	Jouer un son
limitemail	Code international (Requis)
notifyemail	Code international (Requis)
leavenational	Laisser le code national
currency	Symbole de devise/code ISO
currencypos	Convention d’écriture de la devise	gauche: Symbole avant le montant, droite: Symbole après le montant
dialed_num_minimum_length	Longueur minimale du numéro composé
pstn_mode	Mode de numérotation PSTN
callgroups	Groupes d’appel/Groupes de ramassage (séparés par des virgules)
localcodecs	Codecs locaux
remotecodecs	Codecs distants
networkcodecs	Codecs réseau
hdcheck	Vérification des tentatives de connexion
hdlockext	Verrouiller l’extension après X tentatives échouées
hdlockdevice	Verrouiller le téléphone après X extensions verrouillées
hdautologout	Déconnexion automatique
hdlogoutinactive	Déconnexion après X heures d’inactivité
ringtonelocal	Sonnerie pour les appels locaux
hidecallerid	Masquer l’ID de l’appelant dans l’OSC
allowescallerid	Autoriser l’ID de l’appelant ES pour le renvoi d’appel
enablecnamlookup	Activer la recherche de CNAM pour l’ID de l’appelant
setcidforgrouphunt	Définir l’ID de l’appelant pour les appels de chasse de groupe
cidmatchdid	Autoriser uniquement l’ID de l’appelant du tronc dans la plage DID
dropanonymous	Rejeter les appels anonymes
didsaveupdatecid	Sur la sauvegarde de DID, mettre à jour ES/CID/Trunks
forceunknown	Ne pas permettre aux utilisateurs d’envoyer un quelconque ID de l’appelant
hideextnodir	Masquer les extensions sans service (gloCOM)
custompresencetime	Délai hors ligne de la présence gloCOM (en minutes)
usedynfeatures	Utiliser des fonctionnalités dynamiques
nobillingfwd	Désactiver la facturation pour le renvoi d’appel	(obsolète et sera bientôt remplacé par cf_call_rating_disable)
cf_call_rating_disable	Désactiver l’évaluation des appels
jbimpl	Tampon de gigue	hériter, désactivé, fixe, adaptatif
jbmaxsize	Taille maximale (ms)
jbresyncthreshold	Seuil de resynchronisation
jbtargetextra	Extra cible
allowextipauth	Autoriser l’authentification par adresse IP pour les extensions	Oui=1, Non=0
voiceskippin	Ignorer la demande de NIP pour la messagerie vocale	Oui=1, Non=0
email_from	De l’e-mail
vm_email_from	De l’e-mail de la messagerie vocale
local_channels	Canaux locaux
remote_channels	Canaux distants
conferences	Conférences
queues	Files d’attente
auto_attendants	Attendants automatiques
dahdi	DAHDI
dids_notify_email	E-mail de notification
dids_notify_order	Trier par
es_ambulance	Ambulance
es_fire	Feu
es_police	Police
es_notification_email	E-mail de notification
ldap_enabled	Activer LDAP	Oui=1, Non=0
ldap_local_exts	Inclure les extensions système	(Oui=1, Non=0, Non défini=”)
ldap_hotdesking	Activer LDAP pour les périphériques de télétravail	(Oui=1, Non=0, Non défini=”)
ldap_password	Mot de passe LDAP

Exemple de requête :

				
					curl --location 'votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.tenant.add&tenant_name=Client1&tenant_code=999&package=2&ext_length=3&country=france&national=33'

Exemple de réponse :

				
					{
	"success": "Tenant ID: 10",
	"id": 10
}

GET

tenants.edit

Cet action vous permet de modifier un tenant :

https://wiki.bicomsystems.fr/documentation/premiers-pas/tenants/

				
					http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.tenant.list

PARAMS
apikey	Clé d’API généré sur votre PBXware
action	pbxware.tenants.edit Action avec méthodes pour récupérer la ou les valeurs demandées
status	Statut (Non actif=0, Actif=1, Suspendu=2) Les autres arguments sont identiques à ceux de la section Ajout de locataires, à l’exception de ext_length qui ne peut être modifié. Ils sont tous facultatifs, à l’exception de
server	ID du serveur qui doit être fixé à 1
id	ID du tenant

Exemple de requête :

				
					curl --location 'votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.tenant.list'

Exemple de réponse :

				
					{
	"success": "Tenant ID: 10",
	"id": 10
}

GET

tenants.delete

Cet action vous permet de supprimer un tenant :

https://wiki.bicomsystems.fr/documentation/premiers-pas/tenants/

				
					http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.tenant.delete&server=1&id=8

PARAMS
apikey	Clé d’API généré sur votre PBXware
action	pbxware.tenants.edit Action avec méthodes pour récupérer la ou les valeurs demandées
status	Statut (Non actif=0, Actif=1, Suspendu=2) Les autres arguments sont identiques à ceux de la section Ajout de locataires, à l’exception de ext_length qui ne peut être modifié. Ils sont tous facultatifs, à l’exception de
server	ID du serveur qui doit être fixé à 1
id	ID du tenant

Exemple de requête :

				
					curl --location 'votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.tenant.delete&server=1&id=8'

Exemple de réponse :

				
					{
	"success": "Tenant ID: 10",
	"id": 10
}

Tenants

tenants.list

tenants.configuration

tenants.add

tenants.edit

tenants.delete

Tenants

CONTENU