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 ESPAÑA Madrid +34 (910) 601 691 MÉXICO Ciudad de México +52 (55) 8526 36 34 BRASIL Brasilia +55 (61) 9836 4127 São Paulo +55 (12) 9811 155 83 ESTADOS UNIDOS New York +1 (914) 373 71 36 REPÚBLICA DOMINICANA Santo Domingo +1 (829) 249 69 68 CHILE Santiago de Chile +56 (2) 240 533 89 GUATEMALA Ciudad de Guatemala +502 (2) 314 1344 PERÚ Lima +51 (1) 644 91 39

Información del token

< / >

token

Información del token

URL:

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

Descripción:

Esta API Permite realizar un seguimiento detallado de la cantidad de uso de cada token generado.

¿Cómo funciona?:

Esta API funciona a través de un cuerpo de tipo “raw” y una petición en POST, la cual requiere para su correcto funcionamiento los siguientes campos:

Importante: Al consumir esta API, también se consumirá el token y se reducirá en 1 la cantidad restante del disponible de consumo.

– Reemplaza {{operation_name}} por el nombre de su operación.

– En las cabeceras de la petición se requiere:

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

– No hay requerimientos para el cuerpo de la petición.

¿Cómo usar la URL?:

La URL de las APIs contiene un marcador de posición {{crm_server}} que debe ser sustituido por el servidor específico donde se encuentra la operación del cliente.

Servidores disponibles

Actualmente, los servidores disponibles son:

sv0001.crmvox.com
crm.wolkvox.com

¿Cómo determinar el servidor del CRM?

Acceda a la página inicial del CRM mediante el enlace: https://crm.wolkvox.com/.
Inicie sesión utilizando sus credenciales de CRM.
Una vez que haya iniciado sesión y esté en la página de inicio de su plataforma CRM, observe la barra de direcciones del navegador web. La URL en esta barra indica el servidor donde se aloja su operación.
Reemplace {{crm_server}} en la URL original con la URL específica de su servidor de CRM para asegurarse de que la API apunte correctamente a su instancia de CRM.

REQUEST

KEY	DESCRIPCIÓN	EJEMPLO
Wolkvox-Server	Nomenclatura del servidor de la operación.	https://MiServidor.crmvox.com/server/API/v2/token/tokenInformation.php?operation=NombreDeMiOperacion
Wolkvox-Token	Token generado en el módulo de CRM que deseas consultar.	‘Wolkvox-Token: token’
operation	Nombre de la operación.	operation=NombreDeMiOperacion

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 => 'POST',
  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("POST", 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("POST", url, headers=headers, data=payload)

print(response.text)

RESPONSE

KEY	DESCRIPCIÓN	EJEMPLO
code	Indica el código de respuesta HTTP.	“code”: “200”
error	Indica si hubo algún error durante la solicitud.	“error”: “null”
msg	Es un campo que puede proporcionar un mensaje descriptivo acerca del resultado de la solicitud.	“msg”: “1 records were are found”
data	Es el conjunto de datos específicos obtenidos.	“data”: { “description”: “token”, “token_limit”: 4800, “token_use_today”: 0, “available_consumition_options”: 4800, “hours_to_restart_count”: 15 }
description	Es la descripción del token.	“description”: “token”
token_limit	Indica el límite máximo de tokens que se pueden utilizar.	“token_limit”: 4800
token_use_today	Representa la cantidad de tokens utilizados hasta el momento en el día actual.	“token_use_today”: 0
available_consumition_options	Indica la cantidad de tokens que aún pueden ser utilizados.	“available_consumition_options”: 4800
hours_to_restart_count	Muestra la cantidad de horas que deben transcurrir antes de que el contador de uso se reinicie.	“hours_to_restart_count”: 15

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

Posibles códigos de error