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

Consultar casos

< / >

Query Cases

Consultar casos

URL:

https://{{wolkvox_server}}/server/API/v2/cases/queryCases.php

Descripción:

El API de búsqueda de casos nos permite mediante el envío de parámetros buscar registros exclusivamente en dicho módulo ya configurado.

¿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
field
value

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”
field	Es el campo de CRM que utilizaremos para filtrar.	“field”: “status”
value	Es el criterio de búsqueda.	“value”: “In progress”

REQUEST

				
					<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{wolkvox_server}}/server/API/v2/cases/queryCases.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}}",
    "field":"{{field}}",
    "value":"{{value}}"
}
',
  CURLOPT_HTTPHEADER => array(
    'Wolkvox-Token: {{token}}',
    'Content-Type: application/json',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location --request GET 'https://{{wolkvox_server}}/server/API/v2/cases/queryCases.php' \
--header 'Wolkvox-Token: {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "operation":"{{operation}}",
    "field":"{{field}}",
    "value":"{{value}}"
}

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n    \"operation\":\"{{operation}}\",\r\n    \"field\":\"{{field}}\",\r\n    \"value\":\"{{value}}\"\r\n}\r\n\r\n");
Request request = new Request.Builder()
  .url("https://{{wolkvox_server}}/server/API/v2/cases/queryCases.php")
  .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}}/server/API/v2/cases/queryCases.php"

payload = json.dumps({
  "operation": "{{operation}}",
  "field": "{{field}}",
  "value": "{{value}}"
})
headers = {
  'Wolkvox-Token': '{{token}}',
  'Content-Type': 'application/json',
}

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

print(response.text)

RESPONSE

El campo "data" del response entrega todos los campos del módulo más los campos predeterminados que son los siguientes:

KEY	DESCRIPCIÓN	EJEMPLO
idCase	Número de identificación del caso.	“idCase”: “1234”
priority	Indica la prioridad establecida para el caso. En “value” se indica la cantidad de minutos establecida para el tipo de prioridad y “name” es el nombre de la prioridad.	“priority”: { “value”: 30, “name”: “Medium” }
status	Indica el estado actual del caso. En “value” se indica si el tipo de estado tiene la condición de abierto o cerrado. Y “name” indica el nombre del estado.	“status”: { “value”: “open”, “name”: “In progress” }
description_case	Indica la descripción del caso. Al ser compatible con HTML, en este campo se entrega también toda la estructura HTML de la descripción.	“description_case”: “Esta es la descripción del caso”
closeDate	Indica la fecha de finalización del caso. Solo aparecerá la fecha si el caso tiene el estado cerrado.	“closeDate”: “”
contactId	Es el número de identificación del registro del contacto en wolkvox CRM.	“contactId”: “64d2ccxx”
contact	Es el nombre del registro del contacto.	“contact”: “[email protected]”
contactEmail	Es la dirección de correo electrónico del registro del contacto.	“contactEmail”: “[email protected]”
contactTel	Es el número de teléfono del registro del contacto.	“contactTel”: 0000000000
contactIdentification	Es el número de documento de identidad del registro del contacto.	“contactIdentification”: “”
namecompany	Es la empresa relacionada con el caso.	“namecompany”: “”
owner	Indica el id (número de identificación), level (nivel de usuario), name (nombre), mail (correo electrónico) y tel (teléfono) del dueño del caso.	“owner”: { “id”: “”, “level”: “”, “name”: “”, “mail”: “”, “tel”: “” }
prefix	Indica el prefijo del caso.	“prefix”: “PET”
responsible	Indica el id (número de identificación), name (nombre), mail (correo electrónico), tel (número de teléfono) y group (grupo al que pertence. Arroja “false” si no pertenece a uno) del responsable del caso.	“responsible”: { “id”: “”, “name”: “”, “mail”: “”, “tel”: “”, “group”: }
groupsowner	Indica los grupos de propietarios del caso.	“groupsOwner”: []
idPrefijo	Indica el prefijo más el número del caso.	“idPrefijo”: “PET-2132xxcd”
timeEstimated	Indica la fecha y hora estimada para cerrar el caso.	“timeEstimated”: “2023-08-08 14:00:07”
reOpened	Indica si el caso fue reabierto (true) o no (false)	“reOpened”: false
form	Aquí se listan los campos adicionales a los campos predeterminados que vienen en un módulo de casos.	“form”: { “Campo adicional 1”: “” }
history	Aquí se lista el historial de acciones realizadas en el registro. Puede incluir la fecha (date), tipo de acción (type), el usuario que realizó la acción (user), el mensaje del sistema acerca de la acción realizada (message) y el elemento sobre el cual se realizó la acción (status).	“history”: [ { “date”: “2023/8/8 15:59:5”, “type”: “note”, “user”: “Admin – Admin – usuario@modulodeprueba”, “message”: “Añadió la nota: Esto es una nota 2.0”, }, { “date”: “2023/9/29 14:25:29”, “level”: “”, “tag”: “status”, “user”: “Admin – Admin – usuario@modulodeprueba”, “message”: “Cambió el estado de undefined Para In progress” } ]
wolkvox_fecha_creacion	La fecha y creación del caso.	“wolkvox_fecha_creacion”: “2023-08-08 13:30:07”
wolkvox_usuario_creacion	Indica el usuario de creación del caso. Puede aparecer API@ para indicar que el caso fue creado desde una API.	“wolkvox_usuario_creacion”: “API@modulodeprueba”
wolkvox_fecha_modificacion	Indica la fecha y hora de la última modificación del caso.	“wolkvox_fecha_modificacion”: “2023-09-29 14:25:28”
wolkvox_usuario_modificacion	Indica la fecha y hora de la última modificación del caso.	“wolkvox_usuario_modificacion”: “usuario@modulodeprueba”
case_dependent	Indica si el caso es dependiente o independiente (independent).	“case_dependent”: “independent”
wolkvox_origen	Indica el origen de creación del caso.	“wolkvox_origen”: “PostmanRuntime/7.32.3”
wolkvox_ip_address	Indica la dirección IP asociada a la creación del caso.	“wolkvox_ip_address”: “1bb.ccc.ddd.ff”
files	Lista los archivos adjuntos al caso. Incluye el nombre del archivo (name) y la URL.	“files”: [ { “name”: “archivo1.jpg”, “url”: “https://crm.wolkvox.com/…” } ]
nameContact	Nombre del contacto asociado al caso	“nameContact”: “”
caseExpired	Indica si el caso ha expirado (true) o no (false).	“caseExpired”: true
wolkvox_id	Es la identificación única del registro del caso.	“wolkvox_id”: “64d2dcsvb”

				
					{
    "code": "200",
    "error": "null",
    "msg": "x records were are found",
    "data": []
}

Posibles códigos de error