fbpx

< / >

APIs Information

7. Service Information

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/information.php?api=services

Description:

This API allows to have a basic report about the services and licenses used in the operation.

Benefit:

Allows to have basic information on the number of licenses, PBX and active services.

How it works:

  • The consumption of this API is done by GET method.
  • To consume this API you must replace in the url {{{wolkvox_server}} by the nomenclature of the server of the operation.
  • The wolkvox-token header must be used to make use of the authorization token.
  • Note that the same token cannot be consumed simultaneously, so you can schedule the next API to be consumed when the result of the previous one is successful.
  • In terms of time, to keep track of your operation you can make a consumption every 5 minutes of the information.
  • Limit of records that can be downloaded per consumption: 60,000 records.
  • Limit of records that can be uploaded per consumption: 10,000 records.
  • Limit of days queried in dates: 31 days.
  • Limit of result weight: 256 MB.
  • API consumption time limit: 60 seconds.
  • Concurrent consumption limit of a token: 2 simultaneous requests.
  • Daily limit of tokens: Number of licenses multiplied by 1000 daily tokens.

Request

NAMEDESCRIPTIONTYPE
apiType of report requiredString

Response

NAMEDESCRIPTIONTYPE
licensesNumber of active licensesNumber
pbxNumber of active PBXsNumber
screen_recordingScreen recording service (yes/no)String
video_callVideo call service (yes/no)String
stereo_recordingStereo call recording service (yes/no)String
gamificationGamification service (yes/no)String
text_analyticsText analysis service (yes/no)String
speech_analyticsVoice analysis service (yes/no)String
rsyncService of rsync or backup on NAS or other types of local storage (yes/no)String
Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/information.php?api=services',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'wolkvox_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "licenses": "",
            "pbx": "",
            "screen_recording": "",
            "video_call": "",
            "stereo_recording": "",
            "gamification": "",
            "text_analytics": "",
            "speech_analytics": "",
            "rsync": ""
        }
    ]
}
				
			

Usamos cookies, se continuar a navegar assumimos que concorda. Pode ler mais sobre a utilização de cookies nas nossas políticas de privacidade e tratamento de dados pessoais

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