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://{{crm_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?:

El consumo de esta API se realiza mediante el método POST.
En la cabecera de la petición se requiete “Wolkvox-Token” con el token generado en su operación.
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. Actualmente, los servidores disponibles son: “sv0001.crmvox.com” y “crm.wolkvox.com”.
El cuerpo debe construirse en formato “raw“.
En el cuerpo de la petición se requiere: “operation”, “field”, y “value”.

¿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.

Aviso importante: Actualización de rutas de acceso

A partir del 1 de septiembre de 2024, se implementarán nuevas URLs para acceder a la plataforma de wolkvox CRM. Las URLs actuales coexistirán con las nuevas hasta el 30 de noviembre de 2024, fecha en la cual serán deshabilitadas.

Nuevas URLs:

De “https://sv0001.crmvox.com” a “https://crm0001.wolkvox.com“

De “https://sv0000.crmvox.com” a “https://crm0000.wolkvox.com“

Por favor, asegúrate de actualizar tus integraciones y automatizaciones antes del 30 de noviembre de 2024 para evitar interrupciones en el servicio.

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. Puedes usar las siguientes variables para filtrar según lo deseado: “status”, “priority”, “email contact”, “name contact”, “contact wolkvox id”, “contact identification”, “contact phone”, “description”, “idCase”, “idPrefijo”, “companyName”, “company name”, “company id”, “prefix”, “reopened”, “responsible name”, “responsible user”, “responsible id”, “owner name”, “owner user”, “owner id”, “solution”, “wolkvox-id”, “type case”, “case expired” y “reason”	“field”: “status”
value	Es el criterio de búsqueda. Si has decides buscar por tipo de caso, puedes usar “Request” para peticiones, “Complaints” para quejas, “Claims” para reclamos y “Suggestions” para sugerencias.	“value”: “In progress”
limit	Campo opcional que permite paginar la respuesta de la API, limitando la cantidad de registros en cada página. El valor máximo permitido es 250.	“limit”: 250
page	Campo opcional que permite especificar el número de página que se desea consultar en los registros de la respuesta de la API.	“page”: 1

REQUEST

				
					$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 => 'POST',
  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 POST '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("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}}/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("POST", 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	TIPO
code	Código de estado de HTTP que indica el resultado de la solicitud.	string
error	Indica si hubo algún error en la solicitud.	string
page	Número de la página actual de los resultados.	int
Total records	Número total de registros que coinciden con la consulta.	int
Total pages	Número total de páginas disponibles basadas en los resultados de la consulta.	int
msg	Mensaje que describe el resultado de la consulta.	string
data	Contiene la lista de objetos que representan los casos encontrados.	array
idPrefijo	Prefijo y número del caso.	string
form	Contiene los valores de los campos personalizados que fueron creados adicionalmente en el módulo.	object
owner	Contiene información sobre el propietario del caso. Incluye el “id”, “name” y “mail”.	object
prefix	Prefijo utilizado para identificar el tipo de caso. Este depende de la configuración realizada para cada tipo de caso.	string
idCase	Número de identificación único del caso.	string
timeEstimated	Fecha y hora estimadas para la resolución del caso en formato YYYY-MM-DD HH:MM:SS	string
contact	Nombre de la persona de contacto relacionada con el caso.	string
contactId	Número de identificación del registro relacionado con el contacto.	string
contactIdentification	Número de identificación del contacto	string
nameContact	Nombre completo del contacto.	string
companyName	Nombre de la empresa asociada al caso.	string
companyId	Número de identificación del registro relacionado con la empresa.	string
companyIdentification	Número de identificación de la empresa.	string
description_case	Descripción del caso.	string
reOpened	Indica si el caso ha sido reabierto.	boolean
caseType	Tipo de caso. “Request” para peticiones, “Complaints” para quejas, “Claims” para reclamos y “Suggestions” para sugerencias. Si tienes un tipo de caso adicional, aparecerá el nombre con el que lo creaste.	string
files	Lista de archivos adjuntos relacionados con el caso. Incluye el “name” y “url” del archivo. Puedes copiar esta URL para descargar el archivo.	array
groupsOwner	Lista de grupos propietarios del caso.	array
status	Estado actual del caso. Incluye el campo “value” que indica el valor del estado y “name” que indica el nombre del estado.	object
history	Historial de eventos y acciones relacionados con el caso. Cada evento incluye el campo “date” que indica la fecha y hora del evento en formato YYYY/MM/DD HH:MM:SS, “user” usuario que realizó la acción, “tag” etiqueta que describe el tipo de evento y “message” mensaje descriptivo sobre el evento.	array
case_dependent	Indica si el caso depende de otro caso.	string
priority	Prioridad del caso. Incluye “value” que indica el máximo de tiempo en minutos que se debe resolver el caso según la prioridad establecida. “name” indica el nombre de la prioridad.	object
closeDate	Fecha de cierre del caso.	string
responsible	Detalles de la persona responsable del caso. Incluye el campo “id” que indica el ID único del responsable, “name” nombre del responsable, “user” nombre de usuario del responsable, “mail” correo electrónico del responsable, “group” indica si el responasble es un grupo.	boolean
wolkvox_fecha_creacion	Fecha de creación del caso en el sistema. Indicado en formato YYYY-MM-DD HH:MM:SS	string
wolkvox_usuario_creacion	Usuario que creó el caso.	string
wolkvox_fecha_modificacion	Fecha de la última modificación del caso.	string
wolkvox_id	Número de identificación del caso como registro el sistema.	string

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

Posibles códigos de error