Tableau de bord

Temps estimé :8 minutes

Méthodes supportées :

Méthodes	Description
ext_online	Retourne le nombre des extensions en ligne
services	Retourne l’état des services du PBXware
sip_registrations	Retourne l’état des trunks
calls	Retourne le compte des appels
glocom_editions	Retourne la liste des éditions installé sur PBXware
glocom_users	Retourne le nombre de Communicator connecté
licensing	Retourne le nombre licence disponible
disk_usage	Retourne l’espace disque utilisé
cpu	Retourne la quantité de CPU utilisé
memory	Retourne la quantité de mémoire utilisé

GET

ext_online

Cette requête vous renverra le nombre des extensions en ligne.

				
					http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.dashboard.ext_online&server=10

PARAMS
apikey	Clé d’API généré sur votre PBXware
action	pbxware.dashboard.ext_online Action avec méthodes pour récupérer la ou les valeurs demandées
server	10 Filtrage des extensions par tenant ou server selon le mode du PBXware

Exemple de requête :

				
					curl --location 'http://votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.dashboard.ext_online&server=10' \
--data ''

Exemple de réponse :

				
					{
	"type": "Extensions Online",
	"count": 1,
}

GET

services

Cette action permet de remonter l’état des services du PBXware.
6 services au total sont sous surveillance :

https://wiki.bicomsystems.fr/documentation/premiers-pas/tableau-de-bord/#services-pbxware

				
					http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.dashboard.services

PARAMS
apikey	Clé d’API généré sur votre PBXware
action	pbxware.dashboard.services Action avec méthodes pour récupérer la ou les valeurs demandées

Exemple de requête :

				
					curl --location 'http://votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.dashboard.services'

Exemple de réponse :

				
					{
	"PBXware": "running",
	"PBXware service": "running",
	"PBXware proxy": "running",
	"Push notification": "running",
	"Chat server": "running",
	"Memcached": "running"
}

GET

sip_registrations

Cette action vous donnera les tentatives d’enregistrement SIP, réussis, échoués et si il y a du lag :

https://wiki.bicomsystems.fr/documentation/premiers-pas/tableau-de-bord/#enregistrements-sip

				
					http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.dashboard.sip_registrations&server=10

PARAMS
apikey	Clé d’API généré sur votre PBXware
action	pbxware.dashboard.sip_registrations Action avec méthodes pour récupérer la ou les valeurs demandées
server	10 Filtrage des extensions par tenant ou server selon le mode du PBXware

Exemple de requête :

				
					curl --location 'http://votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.dashboard.sip_registrations&server=10'

Exemple de réponse :

				
					{
 "SIP Registrations": {
		"success": 4,
		"failed": 0,
		"lagged": 0
    }
}

GET

calls

Cette action vous retourne les statuts des appels pour trois période : maintenant, dernière heure, et pour la journée en cours.

https://wiki.bicomsystems.fr/documentation/premiers-pas/tableau-de-bord/#aperçu-des-appels

				
					http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.dashboard.calls&server=10

PARAMS
apikey	Clé d’API généré sur votre PBXware
action	pbxware.dashboard.calls Action avec méthodes pour récupérer la ou les valeurs demandées
server	10 Filtrage des extensions par tenant ou server selon le mode du PBXware

Exemple de requête :

				
					curl --location 'http://votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.dashboard.calls&server=10'

Exemple de réponse :

				
					{
	"now": 0,
	"last hour": 6,
	"today": 6,
	"answared calls": 6
}

GET

glocom_editions

Cette action vous renvoie le nombre de Communicators inscrits et par type d’éditions :

https://wiki.bicomsystems.fr/documentation/premiers-pas/tableau-de-bord/#extensions-apps

				
					http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.dashboard.calls&server=10

PARAMS
apikey	Clé d’API généré sur votre PBXware
action	pbxware.dashboard.glocom_editions Action avec méthodes pour récupérer la ou les valeurs demandées
server	10 Filtrage des extensions par tenant ou server selon le mode du PBXware

Exemple de requête :

				
					curl --location 'http://votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.dashboard.glocom_editions&server=10'

Exemple de réponse :

				
					{
	"office": 0,
	"business": 0,
	"agent": 0,
	"supervisor": 0,
	"ios": 0,
	"android": 0
}

GET

glocom_users

Cette action renvoie le nombre de Communicator en ligne.

https://wiki.bicomsystems.fr/documentation/premiers-pas/tableau-de-bord/#extensions-apps

				
					http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.dashboard.glocom_users&server=10

PARAMS
apikey	Clé d’API généré sur votre PBXware
action	pbxware.dashboard.glocom_users Action avec méthodes pour récupérer la ou les valeurs demandées
server	10 Filtrage des extensions par tenant ou server selon le mode du PBXware

Exemple de requête :

				
					curl --location 'http://votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.dashboard.glocom_users&server=10'

Exemple de réponse :

				
					{
   "glocom_users": 0
}

GET

licensing

Cette action renvoie les valeurs utilisées contre le total disponible pour les extensions, les SVI, les files d’attentes et les conférences.

https://wiki.bicomsystems.fr/documentation/premiers-pas/tableau-de-bord/#licence

				
					http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.dashboard.licensing&server=10

PARAMS
apikey	Clé d’API généré sur votre PBXware
action	pbxware.dashboard.licensing Action avec méthodes pour récupérer la ou les valeurs demandées
server	10 Filtrage des extensions par tenant ou server selon le mode du PBXware

Exemple de requête :

				
					curl --location 'http://votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.dashboard.licensing&server=10'

Exemple de réponse :

				
					{
    "ext": {
        "inuse": 14,
        "max": 100
    },
    "ivr": {
        "inuse": 0,
        "max": 200
    },
    "queue": {
        "inuse": 0,
        "max": 200
    },
    "conference": {
        "inuse": 1,
        "max": 200
    }
}

GET

disk_usage

Cette action renvoie l’information sur l’espace disque disponible sur PBXware :

https://wiki.bicomsystems.fr/documentation/premiers-pas/tableau-de-bord/#utilisation-des-ressources-matérielles

				
					http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.dashboard.disk_usage

PARAMS
apikey	Clé d’API généré sur votre PBXware
action	pbxware.dashboard.disk_usage Action avec méthodes pour récupérer la ou les valeurs demandées

Exemple de requête :

				
					curl --location 'http://votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.dashboard.disk_usage'

Exemple de réponse :

				
					{
    "inuse": "45%"
}

GET

cpu

Cette action renvoie l’information sur l’utilisation du CPU sur PBXware :

https://wiki.bicomsystems.fr/documentation/premiers-pas/tableau-de-bord/#utilisation-des-ressources-matérielles

				
					http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.dashboard.cpu

PARAMS
apikey	Clé d’API généré sur votre PBXware
action	pbxware.dashboard.cpu Action avec méthodes pour récupérer la ou les valeurs demandées

Exemple de requête :

				
					curl --location 'http://votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.dashboard.cpu'

Exemple de réponse :

				
					{
    "inuse": "7%"
}

GET

memory

Cette action renvoie l’information sur la mémoire utilisée sur PBXware :

https://wiki.bicomsystems.fr/documentation/premiers-pas/tableau-de-bord/#utilisation-des-ressources-matérielles

				
					http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.dashboard.memory

PARAMS
apikey	Clé d’API généré sur votre PBXware
action	pbxware.dashboard.memory Action avec méthodes pour récupérer la ou les valeurs demandées

Exemple de requête :

				
					curl --location 'http://votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.dashboard.memory'

Exemple de réponse :

				
					{
    "inuse": "14%"
}

Packs

Tableau de bord

ext_online

services

sip_registrations

calls

glocom_editions

glocom_users

licensing

disk_usage

cpu

memory

Tableau de bord

CONTENU