10. Token information - Wolkvox

< / >

APIs

10. Token information

URL:

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

Description:

This API allows for detailed tracking of the quantity of usage for each generated token.

Benefit:

Allows having basic information for resource optimization, avoiding exceeding limits, planning token usage, among other benefits.

How does it work?

The consumption of this API is done using the GET method.
To consume this API, you must replace {{wolkvox_server}} in the URL with the nomenclature of the operation’s server.
You must use the wolkvox-token in the Header to access the authorization token.
Important: When consuming this API, the token will also be consumed, and the remaining available consumption quantity will be reduced by 1.
Keep in mind that the same token cannot be consumed simultaneously, so you can schedule the next API consumption when the result of the previous one is successful.
In terms of timing, to monitor your operation, you can consume the information every 5 minutes.

REQUEST

NAME	DESCRIPTION	TYPE
api	Type of report required	String
wolkvox-token	Token to query	String

RESPONSE

NAME	DESCRIPTION	TYPE
description	Token description.	String
token_limit	This field shows the maximum allowed usage limit for the token within a specific period of time. It represents the maximum number of times the token can be used in a day or any other defined time interval.	String
token_use_today	This field indicates the number of times the token has been used during the current day. It specifies how many times the token has been utilized so far since the day started.	String
all_token_today	This field represents the total of all tokens used during the current day. It is the sum of the usages of all tokens generated in the software during that period.	String
available_consumption_options	This field displays the remaining amount of allowed usages for the token on the current day. It is the result of subtracting the total allowed usages (token_limit) from the number of usages already performed on the day (token_use_today). It indicates how many more times the token can be used before reaching its maximum daily usage limit.	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=token_info',
  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;

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://wv{{wolkvox_server}}.wolkvox.com/api/v2/information.php?api=token_info")
  .method("GET", body)
  .addHeader("wolkvox-token", "{{token}}")
  .build();
Response response = client.newCall(request).execute();

				
					import requests

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

payload = ""
headers = {
  'wolkvox-token': '{{token}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": " 1 records were found",
    "data": [
        {
            "description": " ",
            "token_limit": " ",
            "token_use_today": " ",
            "all_token_today": " ",
            "available_consumption_options": " "
        }
    ]
}

wolkvox
worldwide

UNITED STATES

Atlanta, GA +1 (470) 447-2610
Miami, FL +1 (470) 447-2610

ARGENTINA

Buenos Aires +54 (11) 5217 5933

BRAZIL

Sao Paulo +55 (11) 521 75 933

CHILE

Santiago de Chile +56 (2) 240 533 89

SPAIN

Madrid +34 (910) 601 691

COLOMBIA

Medellín +57 (604) 322 98 80

GUATEMALA

Ciudad de Guatemala +502 (2) 3141344

MEXICO

Ciudad de México +52 (55) 8526 36 34

DOMINICAN REPUBLIC

Santo Domingo +1 (829) 249 69 68

PERU

Lima +51 (1) 644 91 39

|

Information security policy

|

|

Information Transfer Policies

Copyright © 2023 MICROSYSLABS. 1820 N Corporate Lakes Blvd, unit 205. Weston, FL 33326

OMNICHANNEL PLATFORM

CHATBOTS AND VOICEBOTS

wolkvox worldwide

COLOMBIA
Medellín +57 (4) 322 98 80
Bogotá +57 (1) 381 90 40
Cali +57 (2) 891 28 46
Barranquilla +57 (5) 316 10 34

ARGENTINA
Buenos Aires +54 (11) 5217 5933

SPAIN
Madrid +34 (910) 601 691

MEXICO
Ciudad de México +52 (55) 8526 36 34

BRASIL
Brasilia +55 (61) 9836 4127
São Paulo +55 (12) 9811 155 83

UNITED STATES
New York +1 (914) 373 71 36

DOMINICAN REPUBLIC
Santo Domingo +1 (829) 249 69 68

CHILE
Santiago de Chile +56 (2) 240 533 89

GUATEMALA
Ciudad de Guatemala +502 (2) 314 1344

PERU
Lima +51 (1) 644 91 39

Information security policy

Information Transfer Policies

Copyright © 2023 MICROSYSLABS S.A.S.
Cra 30 # 4A – 45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia