Packs
Supported methods:
| Methods | Description |
| list | Returns the list of all existing packages |
| configuration | Returns the configuration of an existing pack |
| add | Allows you to add a package |
| edit | Allows you to edit an existing package |
| delete | Allows you to delete an existing package |
package.list
This action allows you to list all the packs.
http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.package.list | PARAMS | |
| apikey | API key generated on your PBXware |
| action | pbxware.package.list |
Example request:
curl --location 'votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.package.list' Example response:
{ "1": "Package 1", "2": "Package 2", "3": "Package 3", } package.configuration
This action allows you to retrieve the configuration of a particular pack via its id.
http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.package.configuration&id=1 | PARAMS | |
| apikey | API key generated on your PBXware |
| action | pbxware.package.configuration |
| id | 1 |
Example request:
curl --location 'votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.package.configuration&id=1' Example response:
{ "success": "Tenant package: 6", "id": 6 } package.add
This action allows you to list all the packs.
http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.package.add&name=&restrict_splans=0&allowed_service_plans=1&call_recordings=1&monitoring=1&call_screening=1&extensions=100&voicemails=100&queues=100&cfs=100&rgroups=100&hot_desking=100&ivrs=100 | PARAMS | |
| apikey | API key generated on your PBXware |
| action | pbxware.package.add |
| name | Name |
| restrict_plans | 0 |
allowed_service_plans | 1 |
service_plan | Indicates which service packages to use by default. (Regex: /^\d{1,9}$/) |
| call_recordings | 1 |
monitoring | 1 |
call_screening | 1 |
| extensions | 100 |
| voicemails | 100 |
| queues | 100 |
| cfs | 100 |
| rgroups | 100 |
| hot_desking | 100 |
| ivrs | 100 |
Example request:
curl --location 'http://votre.ipbx.fr/index.php?apikey=votre.cle.api&action=pbxware.package.add&name=&restrict_splans=0&allowed_service_plans=1&call_recordings=1&monitoring=1&call_screening=1&extensions=100&voicemails=100&queues=100&cfs=100&rgroups=100&hot_desking=100&ivrs=100' Example response:
{ "success": "Tenant package: 6", "id": 6 } package.edit
This action allows you to retrieve the configuration of a particular pack via its id.
http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.package.configuration&id=6 | PARAMS | |
| apikey | API key generated on your PBXware |
| action | pbxware.package.edit |
| server | 1 |
| id | 1 |
Example request:
curl --location 'votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.package.configuration&id=6' Example response:
{ "success": "Tenant package: 6", "id": 6 } package.delete
This action allows you to retrieve the configuration of a particular pack via its id.
http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.package.delete&server=10&id=1 | PARAMS | |
| apikey | API key generated on your PBXware |
| action | pbxware.package.edit |
| server | 1 |
| id | 1 |
Example request:
curl --location 'votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.package.delete&server=10&id=1' Example response:
{ "success":"Tenant package ID: 1.", "id":"1" } 
