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

Bicom Systems signifie "Business Internet Communication Systems"

leafleafMan illustration
Updated on 21 mars 2024

Packs

Temps estimé :6 minutes

Méthodes supportées :

MéthodesDescription
listRetourne la liste de tous les packages existants
configurationRetourne la configuration d’un pack existant
addPermet d’ajouter un pack
editPermet de modifier un pack existant
deletePermet de supprimer un pack existant
GET

package.list

Cet action vous permet de lister l’ensemble des packs.

https://wiki.bicomsystems.fr/documentation/premiers-pas/packs/

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

Clé d’API généré sur votre PBXware

action

pbxware.package.list
Action avec méthodes pour récupérer la ou les valeurs demandées

Exemple de requête :

				
					curl --location 'votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.package.list'

Exemple de réponse :

				
					{
  "1": "Package 1",
  "2": "Package 2",
  "3": "Package 3",
}
GET

package.configuration

Cet action vous permet de récupérer la configuration d’un pack en particulier via son id.

https://wiki.bicomsystems.fr/documentation/premiers-pas/packs/

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

Clé d’API généré sur votre PBXware

action

pbxware.package.configuration
Action avec méthodes pour récupérer la ou les valeurs demandées

id

1
Valeur retournée par liste de l’objet que vous allez modifier

Exemple de requête :

				
					curl --location 'votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.package.configuration&id=1'

Exemple de réponse :

				
					{
    "success": "Tenant package: 6",
    "id": 6
}
GET

package.add

Cet action vous permet de lister l’ensemble des packs.

https://wiki.bicomsystems.fr/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

Clé d’API généré sur votre PBXware

action

pbxware.package.add
Action avec méthodes pour récupérer la ou les valeurs demandées

name

Nom
(Valeur requise) Nom attribué au package

restrict_plans

0
(Valeur requise si l’options billing est activée) Gérer les restrictions du Service plans. (Regex : /^(1|0)$/)

allowed_service_plans

1
(Valeur Requise si la valeur restrict_splans est activé {1}) Authorisé le service plans (Regex : /^\d{1,9}+(,\d{1,9}+)*$/)

service_plan

Indique les forfaits de service à utiliser par défaut. (Regex : /^\d{1,9}$/)

call_recordings

1
(Valeur requise) activation l’options d’enregistrement d’appels dans les extensions évolués. (Regex: /^(1|0)$/)

monitoring

1
(Valeur requise) activation de l’options du monitoring dans les extensions évoluées. (Regex: /^(1|0)$/)

call_screening

1
(Valeur requise) activé l’options de filtrage des appels dans les extensions évoluées. (Regex: /^(1|0)$/)

extensions

100
(Valeur requise) Nombre max d’extensions. (Regex: /^\d{1,4}$/)

voicemails

100
(Valeur requise) Nombre max de Voicemail. (Regex: /^\d{1,4}$/)

queues

100
(Valeur requise) Nombre max de file d’attente. (Regex: /^\d{1,4}$/)

cfs

100
(Valeur requise) Nombre max de Conférences. (Regex: /^\d{1,4}$/)

rgroups

100
(Valeur requise) Nombre max de groupes d’extensions. (Regex: /^\d{1,4}$/)

hot_desking

100
Valeur retournée par liste de l’objet que vous allez modifier

ivrs

100
(Valeur requise) Nombre max de SVI. (Regex: /^\d{1,4}$/)

Exemple de requête :

				
					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'

Exemple de réponse :

				
					{
    "success": "Tenant package: 6",
    "id": 6
}
GET

package.edit

Cet action vous permet de récupérer la configuration d’un pack en particulier via son id.

https://wiki.bicomsystems.fr/documentation/premiers-pas/packs/

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

Clé d’API généré sur votre PBXware

action

pbxware.package.edit
Action avec méthodes pour récupérer la ou les valeurs demandées

server

1
Valeur retournée par liste de l’objet que vous allez modifier

id

1
Valeur retournée par liste de l’objet que vous allez modifier

Exemple de requête :

				
					curl --location 'votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.package.configuration&id=6'

Exemple de réponse :

				
					{
    "success": "Tenant package: 6",
    "id": 6
}
GET

package.delete

Cet action vous permet de récupérer la configuration d’un pack en particulier via son id.

https://wiki.bicomsystems.fr/documentation/premiers-pas/packs/

				
					http://VOTREIPBX.FR/index.php?apikey=VOTRECLEAPI&action=pbxware.package.delete&server=10&id=1
PARAMS 
apikey

Clé d’API généré sur votre PBXware

action

pbxware.package.edit
Action avec méthodes pour récupérer la ou les valeurs demandées

server

1
Valeur retournée par liste de l’objet que vous allez modifier

id

1
Valeur retournée par liste de l’objet que vous allez modifier

Exemple de requête :

				
					curl --location 'votre.ipbx.fr/index.php?apikey=votre.clé.api&action=pbxware.package.delete&server=10&id=1'

Exemple de réponse :

				
					{
    "success":"Tenant package ID: 1.",
    "id":"1"
}
Tenants
Partager

Packs

Ou copiez le lien ci-dessous

CONTENU