Search
Close this search box.

< / >

APIs

19. Modify Contact Center and PBX Licenses

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/configuration.php?api=edit_licenses

Description:

This API allows modifying the quantity of contact center (agents) and PBX licenses for your operation.

Benefit:

It streamlines and automates the management of contact center and PBX licenses, enabling flexible and efficient resource management according to the operational needs of the business.

How it works:

  • Consumption of this API is done via the PUT method.
  • Parameters are added to the JSON according to the operation or process to be performed.
  • To consume this API, you must replace {{wolkvox_server}} in the URL with the server nomenclature of the operation.
  • The header wolkvox-token: {{token}} must be used to authorize the token.
  • Note that the same token cannot be consumed simultaneously, so you can program the next API to be consumed when the result of the previous one is successful.
  • It is not mandatory to include both {{call_center}} and {{pbx}} at the same time; you can also use just one of them to modify a single parameter.
  • If the number of licenses is reduced using this API and there are users or agents currently using those licenses, they will be blocked in the next action they take after consuming the API. It is recommended to ensure that there are no active users before reducing the number of licenses or to take necessary measures to avoid interruptions in service.

Request

NAMEDESCRIPTIONTYPE
call_centerNumber of agent licenses for the current operation.String
pbxNumber of PBX user licenses for the current operation.String

Response

NAMEDESCRIPTIONTYPE
codeResponse code.int
errorError.String
msgDescription of the response.String
Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/configuration.php?api=edit_licenses',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_POSTFIELDS =>'{
    "call_center": "{{call_center}}",
    "pbx": "{{pbx}}"
}',
  CURLOPT_HTTPHEADER => array(
    'wolkvox_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": " - Change of contact center licenses from X to X - Change of PBX licenses from X to X"
}
				
			
We use cookies, if you continue browsing we will assume that you agree. You can read more about the use of cookies in our privacy policies and treatment of personal data