FR EN
leafleaf
Updated on March 21, 2024

Dashboard

Estimated reading: 6 minutes

Supported methods:

MethodsDescription
ext_onlineReturns the number of online extensions
servicesReturns the status of PBXware services
sip_registrationsReturns the status of trunks
callsReturns the call count
glocom_editionsReturns the list of editions installed on PBXware
glocom_usersReturns the number of connected Communicator instances
licensingReturns the number of available licenses
disk_usageReturns the disk space used
cpuReturns the amount of CPU used
memoryReturns the amount of memory used
GET

ext_online

This query will return the number of extensions online.

http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.dashboard.ext_online&server=10
PARAMS
apikeyAPI key generated on your PBXware
action

pbxware.dashboard.ext_online
Action with methods to retrieve the requested value(s)

server10
Filtering of extensions by tenant or server depending on the PBXware mode

Example request:

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

Example response:

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

services

This action allows you to report the status of the PBXware services.
6 services in total are being monitored:

/documentation/premiers-pas/tableau-de-bord/#services-pbxware

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

API key generated on your PBXware

action

pbxware.dashboard.services
Action with methods to retrieve the requested value(s)

Example request:

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

Example response:

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

sip_registrations

This action will give you the SIP registration attempts, successful, failed, and whether there is any lag:

/documentation/premiers-pas/tableau-de-bord/#enregistrements-sip

http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.dashboard.sip_registrations&server=10
PARAMS
apikeyAPI key generated on your PBXware
action

pbxware.dashboard.sip_registrations
Action with methods to retrieve the requested value(s)

server10
Filtering of extensions by tenant or server depending on the PBXware mode

Example request:

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

Example response:

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

calls

This action returns the call statuses for three periods: now, the last hour, and for the current day.

/documentation/premiers-pas/tableau-de-bord/#aperçu-des-appels

http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.dashboard.calls&server=10
PARAMS
apikeyAPI key generated on your PBXware
action

pbxware.dashboard.calls
Action with methods to retrieve the requested value(s)

server10
Filtering of extensions by tenant or server depending on the PBXware mode

Example request:

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

Example response:

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

glocom_editions

This action returns the number of registered Communicators and by edition type:

/documentation/premiers-pas/tableau-de-bord/#extensions-apps

http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.dashboard.calls&server=10
PARAMS
apikeyAPI key generated on your PBXware
action

pbxware.dashboard.glocom_editions
Action with methods to retrieve the requested value(s)

server10
Filtering of extensions by tenant or server depending on the PBXware mode

Example request:

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

Example response:

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

glocom_users

This action returns the number of online Communicators.

/documentation/premiers-pas/tableau-de-bord/#extensions-apps

http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.dashboard.glocom_users&server=10
PARAMS
apikeyAPI key generated on your PBXware
action

pbxware.dashboard.glocom_users
Action with methods to retrieve the requested value(s)

server10
Filtering of extensions by tenant or server depending on the PBXware mode

Example request:

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

Example response:

{ "glocom_users": 0 }
GET

licensing

This action returns the values used against the total available for extensions, IVRs, queues, and conferences.

/documentation/premiers-pas/tableau-de-bord/#licence

http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.dashboard.licensing&server=10
PARAMS
apikeyAPI key generated on your PBXware
action

pbxware.dashboard.licensing
Action with methods to retrieve the requested value(s)

server10
Filtering of extensions by tenant or server depending on the PBXware mode

Example request:

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

Example response:

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

disk_usage

This action returns information about the available disk space on PBXware:

/documentation/premiers-pas/tableau-de-bord/#utilisation-des-ressources-matérielles

http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.dashboard.disk_usage
PARAMS
apikeyAPI key generated on your PBXware
action

pbxware.dashboard.disk_usage
Action with methods to retrieve the requested value(s)

Example request:

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

Example response:

{ "inuse": "45%" }
GET

cpu

This action returns information about the CPU usage on PBXware:

/documentation/premiers-pas/tableau-de-bord/#utilisation-des-ressources-matérielles

http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.dashboard.cpu
PARAMS
apikeyAPI key generated on your PBXware
action

pbxware.dashboard.cpu
Action with methods to retrieve the requested value(s)

Example request:

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

Example response:

{ "inuse": "7%" }
GET

memory

This action returns information about the memory used on PBXware:

/documentation/premiers-pas/tableau-de-bord/#utilisation-des-ressources-matérielles

http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.dashboard.memory
PARAMS
apikeyAPI key generated on your PBXware
action

pbxware.dashboard.memory
Action with methods to retrieve the requested value(s)

Example request:

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

Example response:

{ "inuse": "14%" }
Packs
Share

Dashboard

Or copy the link below

CONTENT