fbpx

< / >

Query Dates

Query Dates

URL:

https://{{wolkvox_server}}/server/API/v2/custom/queryDates.php

Descripción:

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.

¿Cómo funciona?:

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

En las cabeceras de la petición se requiere:

  • Wolkvox-Token

– En el cuerpo de la petición se requiere:

  • operation
  • module
  • date
  • from
  • to

 Como requisito para que funcione correctamente la búsqueda mediante un rango de fechas se debe establecer el valor del campo “date” en “true”.

REQUEST

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”

REQUEST

				
					<?php

$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 => 'GET',
  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;

				
			

RESPONSE

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": ""
    }
]
				
			
Posibles códigos de error

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