ARGENTINA
Buenos Aires +54 (11) 5217 5933
BRASIL
Goiânia +55 (62) 99328 6605
CHILE
Santiago de Chile +56 (2) 240 533 89
https://{{crm_server}}/server/API/v2/custom/queryDates.php
El API de búsqueda por fechas nos permite, mediante el envío de parámetros, buscar registros en los módulos parametrizados de nuestro CRM mediante un rango de fechas definido.
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:
– En las cabeceras de la petición se requiere:
– En el cuerpo de la petición se requiere:
Como requisito para que funcione correctamente la búsqueda mediante un rango de fechas se debe establecer el valor del campo “date” en “true”.
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:
¿Cómo determinar el servidor del CRM?
KEY | DESCRIPCIÓN | EJEMPLO |
---|---|---|
Wolkvox-Token | Es el token configurado por el cliente en la página de CRM. | A8K3J7F2 |
operation | Es el nombre de la operación del CRM. | “operation”: “modulodeprueba” |
module | Nombre del módulo para consultar. | contacts |
date | Es un campo condicional para determinar la búsqueda por rango de fecha. Este debería ir en TRUE para realizar la consulta por fechas. | “date”: true |
from | Es el rango inicial para generar la consulta. | “from”: “2023-09-01 00:00” |
to | Es el rango final para generar la consulta. | “to”: “2023-09-30 00:00” |
limit | Este campo es opcional y hace referencia al límite de registros que se desea ver en la respuesta. | “limit”: “2” |
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://{{wolkvox_server}}/server/API/v2/custom/queryDates.php',
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_POSTFIELDS =>'{
"operation":"{{operation}}",
"module":"{{module}}",
"date": {{date}},
"from": "{{from}}",
"to": "{{to}}"
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
'Wolkvox-Token: {{token}}'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
curl --location --request POST 'https://{{wolkvox_server}}/server/API/v2/custom/queryDates.php' \
--header 'Content-Type: application/json' \
--header 'Wolkvox-Token: {{token}}' \
--data-raw '{
"operation":"{{operation}}",
"module":"{{module}}",
"date": {{date}},
"from": "{{from}}",
"to": "{{to}}"
}'
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n \"operation\":\"{{operation}}\",\r\n \"module\":\"{{module}}\",\r\n \"date\": {{date}},\r\n \"from\": \"{{from}}\",\r\n \"to\": \"{{to}}\"\r\n \r\n }");
Request request = new Request.Builder()
.url("https://{{wolkvox_server}}/server/API/v2/custom/queryDates.php")
.method("POST", body)
.addHeader("Content-Type", "application/json")
.addHeader("Wolkvox-Token", "{{token}}")
.build();
Response response = client.newCall(request).execute();
import requests
import json
url = "https://{{wolkvox_server}}/server/API/v2/custom/queryDates.php"
payload = json.dumps({
"operation": "{{operation}}",
"module": "{{module}}",
"date": {{date}},
"from": "{{from}}",
"to": "{{to}}"
})
headers = {
'Content-Type': 'application/json',
'Wolkvox-Token': '{{token}}',
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
Entrega todos los campos creados en el módulo más los campos predeterminados que son los siguientes:
KEY | DESCRIPCIÓN | EJEMPLO |
---|---|---|
wolkvox_usuario_creacion | Es el usuario que creó el registro. | “wolkvox_usuario_creacion”: “admin@modulodeprueba” |
wolkvox_fecha_creacion | Es el nombre de la operación del CRM. | “wolkvox_fecha_creacion”: “2023-09-29 10:59:54” |
wolkvox_origen | Indica desde dónde fue creado el registro | “PostmanRuntime/7.33.0 – /server/API/v2/custom/insert.php” |
wolkvox_ip_address | Indica la IP pública desde la cual fue creado el registro. | “wolkvox_ip_address”: “xxx.ccc.ddd.ee – v2” |
wolkvox_owner | Muestra un conjunto de datos acerca del propietario del registro. Este conjunto de datos incluye el nombre de usuario (user), el nombre (nombre), número de id (id) y correo electrónico (email). | “wolkvox_owner”: {
“user”: “api”,
“nombre”: “api”,
“id”: “api”,
“email”: “api”
} |
wolkvox_id | Es el número de identificación del registro en wolkvox CRM. | “wolkvox_id”: “6cvvbbxx” |
[
{
"wolkvox_usuario_creacion": "",
"wolkvox_fecha_creacion": "",
"wolkvox_origen": "",
"wolkvox_ip_address": "",
"wolkvox_owner": {
"user": "",
"nombre": "",
"id": "",
"email": ""
},
"wolkvox_id": ""
}
]
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
Goiânia +55 (62) 99328 6605
Santiago de Chile +56 (2) 240 533 89
Atlanta +1 (678) 496 7474
Ciudad de Guatemala +502 (2) 314 1344
Ciudad de México +52 (55) 8526 36 34
Copyright © 2022 MICROSYSLABS S.A.S. Todos los derechos reservados. Cra 30 # 4A-45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia
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
Copyright © 2022 MICROSYSLABS S.A.S.
Todos los derechos reservados.
Cra 30 # 4A – 45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia
Usamos cookies, se continuar a navegar assumimos que concorda. Pode ler mais sobre a utilização de cookies nas nossas políticas de privacidade e tratamento de dados pessoais
Hacemos uso de cookies, si continúas navegando asumiremos que estás de acuerdo. Puede leer más sobre el uso de cookies en nuestras políticas de privacidad y tratamiento de datos personales