FR EN

Packs

Estimated reading: 4 minutes
GET

package.list

This action allows you to list all the packs.

/documentation/premiers-pas/packs/

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

API key generated on your PBXware

action

pbxware.package.list
Action with methods to retrieve the requested value(s)

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

package.configuration

This action allows you to retrieve the configuration of a particular pack via its id.

/documentation/premiers-pas/packs/

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
Action with methods to retrieve the requested value(s)

id

1
Value returned by list for the object you are going to modify

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 }
GET

package.add

This action allows you to list all the packs.

/documentation/premiers-pas/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
Action with methods to retrieve the requested value(s)

name

Name
(Value required) Name assigned to the package

restrict_plans

0
(Value required if the billing option is enabled) Manage Service plans restrictions. (Regex: /^(1|0)$/)

allowed_service_plans

1
(Value required if the restrict_splans value is enabled {1}) Authorize the service plans (Regex: /^\d{1,9}+(,\d{1,9}+)*$/)

service_plan

Indicates which service packages to use by default. (Regex: /^\d{1,9}$/)

call_recordings

1
(Value required) enable the call recording option in enhanced extensions. (Regex: /^(1|0)$/)

monitoring

1
(Value required) enable the monitoring option in enhanced extensions. (Regex: /^(1|0)$/)

call_screening

1
(Value required) enable the call filtering option in enhanced extensions. (Regex: /^(1|0)$/)

extensions

100
(Value required) Max number of extensions. (Regex: /^\d{1,4}$/)

voicemails

100
(Value required) Max number of Voicemails. (Regex: /^\d{1,4}$/)

queues

100
(Value required) Max number of queues. (Regex: /^\d{1,4}$/)

cfs

100
(Value required) Max number of Conferences. (Regex: /^\d{1,4}$/)

rgroups

100
(Value required) Max number of extension groups. (Regex: /^\d{1,4}$/)

hot_desking

100
Value returned by list for the object you are going to modify

ivrs

100
(Value required) Max number of IVRs. (Regex: /^\d{1,4}$/)

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 }
GET

package.edit

This action allows you to retrieve the configuration of a particular pack via its id.

/documentation/premiers-pas/packs/

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
Action with methods to retrieve the requested value(s)

server

1
Value returned by list for the object you are going to modify

id

1
Value returned by list for the object you are going to modify

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 }
GET

package.delete

This action allows you to retrieve the configuration of a particular pack via its id.

/documentation/premiers-pas/packs/

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
Action with methods to retrieve the requested value(s)

server

1
Value returned by list for the object you are going to modify

id

1
Value returned by list for the object you are going to modify

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" } 
Share

Packs

Or copy the link below

CONTENT