Search
Close this search box.
Search
Close this search box.

< / >

APIs Billing

27. NLP

URL:

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

Description:

This API allows to have a basic report about NLP consumption.

Benefit:

It allows to obtain a basic report of the use that has been made of the NLP.

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 server nomenclature of the operation and the {token} generated from wolkvox Manager to obtain the information in a secure way.
  • 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.
  • The query of this api is done only 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

NAME DESCRIPTION TYPE
api Type of report required String

Response

NAME DESCRIPTION TYPE
operation Indicates the name of the operation String
description Description of NLP usage String
items Service consumption String
date Month and year of report 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=nlp_ai',
  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