Wiki en construction / PBXware 7.0 - Incident concernant les services évolués en français

Bicom Systems signifie "Business Internet Communication Systems"

Tenants

Temps estimé :11 minutes
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_codeCode 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 
apikeyClé d’API généré sur votre PBXware
actionpbxware.tenants.configuration
Action avec méthodes pour récupérer la ou les valeurs demandées
tenant_nameNom du locataire (Requis)
tenant_codeCode locataire unique à 3 chiffres (Requis)
packageIdentifiant de package locataire (Requis)
ext_lengthLongueur des extensions (Requis)
countryID pays (Requis)
area_codeCode de zone (Requis)
nationalCode national (Requis)
internationalCode international (Requis)
glocom_dns_srv_lookupUtiliser la recherche DNS SRV pour gloCOM
glocomproxyProxy SIP pour gloCOM
apusernameNom d’utilisateur HTTP
appasswordMot de passe HTTP
defaultserverServeur par défaut
announcetrunksAnnoncer les troncs
absolutetimeoutDélai absolu
cdrvoicemailMessagerie vocale dans les CDR
faxformatFormat de page FAX
faxfiletypeType de fichier FAX
enabletcallsActiver les appels locataire à locataire
disabletcidDésactiver la réécriture de l’ID appelant pour les appels locataire à locataire
tenantcidID appelant par défaut
tenant_faxcidID appelant FAX par défaut
usedefaultcidUtiliser l’ID appelant par défaut pour les appels locataire à locataire
usedidcidUtiliser les DIDs comme ID appelant pour les appels locataire à locataire
finde164Trouver des numéros E.164 dans les DIDs
recordlimitNombre d’objets par page (Par défaut : 10)
showdiroscAfficher l’annuaire dans OSC
recordglobalEnregistrer les appels par défaut
recordsilentEnregistrement silencieux par défaut
mp3_auto_convConvertir les enregistrements en mp3 lors de la génération
recordbeepJouer un bip périodique
recordformatFormat d’enregistrement
audiolangLangue audio
cpark_timeoutDélai de stationnement d’appel amélioré (en secondes)
cpark_dialAnnonce de stationnement d’appel amélioré
cpark_gotoExtension de délai de stationnement d’appel amélioré
limitsoundJouer un son
limitemailCode international (Requis)
notifyemailCode international (Requis)
leavenationalLaisser le code national
currencySymbole de devise / Code ISO
currencyposConvention d’écriture de la devise
dialed_num_minimum_lengthLongueur minimale du numéro composé
pstn_modeMode de numérotation PSTN
callgroupsGroupes d’appel / Groupes de capture (séparés par des virgules)
incominglimitCanaux locaux
outgoinglimitCanaux distants
conchCanaux de conférence
quechCanaux de file d’attente
ergchCanaux de groupes de sonnerie améliorés
aachCanaux d’assistants automatiques
zapchCanaux DAHDI
localcodecsCodecs locaux
remotecodecsCodecs distants
networkcodecsCodecs réseau
hdcheckVérification des tentatives de connexion
hdlockextVerrouiller l’extension après X tentatives échouées
hdlockdeviceVerrouiller le téléphone après X extensions verrouillées
hdautologoutDéconnexion automatique
hdlogoutinactiveDéconnexion après X heures d’inactivité
ringtonelocalSonnerie pour les appels locaux
hidecalleridMasquer l’ID appelant dans OSC
allowescalleridAutoriser « ES CallerID » pour le renvoi d’appel
enablecnamlookupActiver la recherche CNAM de l’ID appelant
setcidforgrouphuntDéfinir l’ID appelant pour les appels de chasse de groupe
cidmatchdidAutoriser uniquement l’ID appelant du tronc dans la plage DID
dropanonymousRejeter les appels anonymes
didsaveupdatecidSur enregistrement DID, mettre à jour ES/CID/Trunks
forceunknownNe pas autoriser les utilisateurs à envoyer un ID appelant quelconque
hideextnodirMasquer les extensions sans département (gloCOM)
custompresencetimeDélai de présence hors ligne de gloCOM (minutes)
usedynfeaturesUtiliser 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_disableDé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
apikeyClé d’API générée sur votre PBXware 
actionpbxware.tenants.add
Action avec méthodes pour récupérer la ou les valeurs demandées
 
tenant_nameNom du locataire (Requis)Doit être un FQDN valide (Fully Qualified Domain Name)
tenant_codeCode de locataire unique à 3 chiffres (Requis) 
packageID de package du locataire (Requis)Peut être obtenu avec l’objet package
ext_lengthLongueur des extensions (Requis)Peut être dans la plage 2-16 UNIQUEMENT
countryID du pays (Requis)Peut être obtenu avec l’objet route
area_codeCode régional 
nationalCode national (Requis) 
internationalCode international (Requis) 
glocom_dns_srv_lookupUtiliser la recherche DNS SRV gloCOM 
glocomproxyProxy SIP gloCOM 
apusernameNom d’utilisateur HTTP 
appasswordMot de passe HTTP 
defaultserverServeur par défaut 
announcetrunksAnnoncer les troncs 
absolutetimeoutDélai absolu 
cdrvoicemailBoîte vocale dans les CDR2: Comme Boîte vocale, 1: Comme appels non répondus, 0: Comme appels répondus
faxformatFormat de page FAXlettre, légal, A4, auto
faxfiletypeType de fichier FAX1: PDF et TIFF, 2: Seulement PDF, 3: Seulement TIFF
default_locationEmplacement d’extension par défaut (Local=1, Remote=2) 
enabletcallsActiver les appels entre locataires 
disabletcidDésactiver la réécriture de l’ID de l’appelant pour les appels entre locataires 
tenantcidID de l’appelant par défaut 
tenant_faxcidID de l’appelant par défaut pour le fax 
usedefaultcidUtiliser l’ID de l’appelant par défaut pour les appels entre locataires 
usedidcidUtiliser les DIDs comme ID de l’appelant pour les appels entre locataires 
finde164Trouver les numéros E.164 dans les DIDs 
recordlimitNombre d’objets par page (Par défaut : 10) 
showdiroscAfficher le répertoire dans l’OSC 
recordglobalEnregistrer les appels par défaut 
recordsilentEnregistrement silencieux par défaut 
mp3_auto_convConvertir les enregistrements en mp3 à la génération 
recordbeepJouer le bip périodique 
recordformatFormat des enregistrementsgsm: GSM, wav: WAV, wav49: WAV49, g729: G729 natif, ogg: OGG
audiolangLangue audio 
cpark_timeoutDélai de stationnement des appels amélioré (en secondes) 
cpark_dialExtension d’annonce du stationnement des appels amélioré 
cpark_gotoExtension de délai d’expiration du stationnement des appels amélioré 
limitsoundJouer un son 
limitemailCode international (Requis) 
notifyemailCode international (Requis) 
leavenationalLaisser le code national 
currencySymbole de devise/code ISO 
currencyposConvention d’écriture de la devisegauche: Symbole avant le montant, droite: Symbole après le montant
dialed_num_minimum_lengthLongueur minimale du numéro composé 
pstn_modeMode de numérotation PSTN 
callgroupsGroupes d’appel/Groupes de ramassage (séparés par des virgules) 
localcodecsCodecs locaux 
remotecodecsCodecs distants 
networkcodecsCodecs réseau 
hdcheckVérification des tentatives de connexion 
hdlockextVerrouiller l’extension après X tentatives échouées 
hdlockdeviceVerrouiller le téléphone après X extensions verrouillées 
hdautologoutDéconnexion automatique 
hdlogoutinactiveDéconnexion après X heures d’inactivité 
ringtonelocalSonnerie pour les appels locaux 
hidecalleridMasquer l’ID de l’appelant dans l’OSC 
allowescalleridAutoriser l’ID de l’appelant ES pour le renvoi d’appel 
enablecnamlookupActiver la recherche de CNAM pour l’ID de l’appelant 
setcidforgrouphuntDéfinir l’ID de l’appelant pour les appels de chasse de groupe 
cidmatchdidAutoriser uniquement l’ID de l’appelant du tronc dans la plage DID 
dropanonymousRejeter les appels anonymes 
didsaveupdatecidSur la sauvegarde de DID, mettre à jour ES/CID/Trunks 
forceunknownNe pas permettre aux utilisateurs d’envoyer un quelconque ID de l’appelant 
hideextnodirMasquer les extensions sans service (gloCOM) 
custompresencetimeDélai hors ligne de la présence gloCOM (en minutes) 
usedynfeaturesUtiliser des fonctionnalités dynamiques 
nobillingfwdDésactiver la facturation pour le renvoi d’appel(obsolète et sera bientôt remplacé par cf_call_rating_disable)
cf_call_rating_disableDésactiver l’évaluation des appels
jbimplTampon de giguehériter, désactivé, fixe, adaptatif
jbmaxsizeTaille maximale (ms) 
jbresyncthresholdSeuil de resynchronisation 
jbtargetextraExtra cible 
allowextipauthAutoriser l’authentification par adresse IP pour les extensionsOui=1, Non=0
voiceskippinIgnorer la demande de NIP pour la messagerie vocaleOui=1, Non=0
email_fromDe l’e-mail 
vm_email_fromDe l’e-mail de la messagerie vocale 
local_channelsCanaux locaux 
remote_channelsCanaux distants 
conferencesConférences 
queuesFiles d’attente 
auto_attendantsAttendants automatiques 
dahdiDAHDI 
dids_notify_emailE-mail de notification 
dids_notify_orderTrier par 
es_ambulanceAmbulance 
es_fireFeu 
es_policePolice 
es_notification_emailE-mail de notification 
ldap_enabledActiver LDAPOui=1, Non=0
ldap_local_extsInclure les extensions système(Oui=1, Non=0, Non défini=”)
ldap_hotdeskingActiver LDAP pour les périphériques de télétravail(Oui=1, Non=0, Non défini=”)
ldap_passwordMot 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 
apikeyClé d’API généré sur votre PBXware
actionpbxware.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 
apikeyClé d’API généré sur votre PBXware
actionpbxware.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
}
				
			
Partager

Tenants

Ou copiez le lien ci-dessous

CONTENU