Search
Close this search box.

< / >

APIs Billing

1. Agent Script

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/billing.php?api=agent_script

Description:

This API allows to query the amount of active Agent Script licenses relating the operation name, product and the query date.

Benefit:

It allows to make a periodic check on the operation of the functionalities in use.

How it works:

  • The consumption of this API is done by GET method.
  • To consume this API you must replace in the url {ip_ipdialbox} by the nomenclature of the operation server and the {token} generated from wolkvox Manager to obtain the information safely.
  • Keep in mind 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.
  • The query of this api is only made in the current month.
  • In terms of time, to track 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

Request

NAME DESCRIPTION TYPE
api Type of report required. String

Response

NAME DESCRIPTION TYPE
operation Indicates the name of the operation. String
description It refers to the product of which its consumption is consulted. String
items Indicates the amount of use. String
date Indicates the date of the query. String
Possible response codes
				
					$curl = curl_init();
 
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/billing.php?api=agent_script',
  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-token: {{token}}'
  ),
));
 
$response = curl_exec($curl);
 
curl_close($curl);
echo $response;
				
			

RESPONSE

				
					{
    "code": 200,
    "error": null,
    "msg": "Information found for the current month",
    "data": [
        {
            "operation": "",
            "description": "",
            "items": "",
            "date": ""
        }
    ]
}

				
			
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