Token information - crmvox

< / >

token

Token information

URL:

https://{{wolkvox_server}}.crmvox.com/server/API/v2/token/tokenInformation.php?operation={{operation_name}}

Description:

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

How it works?:

This API operates through a GET request, which requires the following fields for its proper functioning:

Important: When consuming this API, the token will also be consumed, reducing the remaining consumption availability by 1.

– In the request headers, the following is required:

Wolkvox-Token: {{token}}
Content-Type: application/json

– There are no requirements for the request body.

REQUEST

KEY	DESCRIPTION	EXAMPLE
Wolkvox-Server	Operation server nomenclature.	https://MyServer.crmvox.com/server/API/v2/token/tokenInformation.php?operation=OperationName
Wolkvox-Token	The token generated in the CRM module that you want to query.	‘Wolkvox-Token: token’
operation	Operation name.	operation=OperationName

RESPONSE

KEY	DESCRIPTION	EXAMPLE
code	Indicate the HTTP response code.	“code”: “200”
error	Indicate if there was any error during the request.	“error”: “null”
msg	It is a field that can provide a descriptive message about the outcome of the request.	“msg”: “1 records were are found”
data	It is the specific dataset obtained.	“data”: { “description”: “token”, “token_limit”: 4800, “token_use_today”: 0, “available_consumition_options”: 4800, “hours_to_restart_count”: 15 }
description	It is the token description.	“description”: “token”
token_limit	Indicates the maximum limit of tokens that can be used.	“token_limit”: 4800
token_use_today	Represents the number of tokens used up to the current moment in the current day.	“token_use_today”: 0
available_consumition_options	Indicates the number of tokens that can still be used.	“available_consumition_options”: 4800
hours_to_restart_count	Shows the number of hours that must pass before the usage counter resets.	“hours_to_restart_count”: 15

REQUEST

				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{wolkvox_server}}.crmvox.com/server/API/v2/token/tokenInformation.php?operation={{operation_name}}',
  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}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location 'https://{{wolkvox_server}}.crmvox.com/server/API/v2/token/tokenInformation.php?operation={{operation_name}}' \
--header 'Wolkvox-Token: {{token}}' \
--header 'Content-Type: application/json' \
--data ''

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://{{wolkvox_server}}.crmvox.com/server/API/v2/token/tokenInformation.php?operation={{wolkvox_operation}}")
  .method("GET", body)
  .addHeader("Wolkvox-Token", "{{token}}")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

				
					import requests
import json

url = "https://{{wolkvox_server}}.crmvox.com/server/API/v2/token/tokenInformation.php?operation={{operation_name}}"

payload = ""
headers = {
  'Wolkvox-Token': '{{token}}',
  'Content-Type': 'application/json',
}

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

print(response.text)

RESPONSE

				
					{
    "code": "",
    "error": "",
    "msg": "",
    "data": {
        "description": "",
        "token_limit": ,
        "token_use_today": ,
        "available_consumition_options": ,
        "hours_to_restart_count": 
    }
}

Possible error codes

wolkvox
worldwide

COLOMBIA

Medellín +57 (604) 322 98 80
Bogotá +57 (601) 381 90 40
Cali +57 (602) 891 28 46
Barranquilla +57 (605) 316 10 34

ARGENTINA

Buenos Aires +54 (11) 5217 5933

BRAZIL

Goiânia +55 (62) 99328 6605

CHILE

Santiago de Chile +56 (2) 240 533 89

SPAIN

Madrid +34 (910) 601 691

UNITED STATES

Atlanta +1 (678) 496 7474

GUATEMALA

Ciudad de Guatemala +502 (2) 314 1344

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

|

Privacy policy and treatment of personal data

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

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

Privacy policy and treatment of personal data

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