ARGENTINA
Buenos Aires +54 (11) 5217 5933
BRASIL
Goiânia +55 (62) 99328 6605
CHILE
Santiago de Chile +56 (2) 240 533 89
Menu
Menu
Menu
https://{{crm_server}}//server/API/v2/cases/listHistoryNote.php
El API permite listar el historial de notas de los casos asociados a una empresa.
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:
– Tener en cuenta:
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?
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.
KEY | DESCRIPCIÓN | EJEMPLO |
|---|---|---|
Wolkvox-Token | Es el token configurado por el cliente en la página de CRM. Este debe ser de tipo “externo” y de la empresa asociada a los casos de los cuales se desea consultar las notas. | A8K3J7F2 |
operation | Es el nombre de la operación del CRM. | “operation”: “modulodeprueba” |
field | Es el campo del módulo de casos que deseas usar para encontrar las notas. Puedes usar “type case” para buscar por tipo de caso. | “field”: “type case” |
value | Es el criterio de búsqueda según el campo indicado. Si has usado “type case” en el anterior campo, puedes usar “Request” para peticiones, “Complaints” para quejas, “Claims” para reclamos y “Suggestions” para sugerencias. | “value”: “Request” |
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 |
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://{{wolkvox_server}}//server/API/v2/cases/listHistoryNote.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}}",
"limit": {{limit}}
}',
CURLOPT_HTTPHEADER => array(
'Wolkvox-Token: {{wolkvox_token}}',
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $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": [
{
"idCase": "",
"caseType": "",
"priority": {
"value": ,
"name": ""
},
"status": {
"value": "",
"name": ""
},
"description_case": "",
"closeDate": "",
"contactId": "",
"contact": "",
"contactEmail": "",
"contactTel": {
"value": "",
"country": "",
"code": ""
},
"contactIdentification": "",
"namecompany": "",
"owner": {
"id": "",
"level": null,
"name": "",
"mail": "",
"tel": ""
},
"prefix": "",
"responsible": {
"id": "",
"name": "",
"mail": "",
"tel": "",
"group":
},
"groupsOwner": [],
"idPrefijo": "",
"timeEstimated": "",
"reOpened": ,
"form": {
"valor": "",
"Nombre": "",
"canal": "",
"asunto": ""
},
"history": [
{
"date": "",
"type": "note",
"user": "",
"message": "Añadió la nota: Este es el cuerpo de la nota"
},
{
"date": "",
"type": "note",
"user": "",
"message": "Añadió la nota: Este es el cuerpo de la nota"
},
{
"date": "",
"type": "note",
"user": "",
"message": "Añadió la nota: Este es el cuerpo de la nota"
},
{
"date": "",
"message": "",
"user": ""
},
{
"color": "",
"date": "",
"level": "",
"tag": "",
"user": "",
"message": ""
},
{
"color": "",
"date": "",
"level": "",
"tag": "",
"user": "",
"message": ""
},
{
"date": "",
"type": "note",
"user": "",
"message": "Añadió la nota: Este es el cuerpo de la nota"
},
{
"date": "",
"type": "note",
"user": "",
"message": "Añadió la nota: Este es el cuerpo de la nota"
},
{
"date": "",
"type": "note",
"user": "",
"message": "Añadió la nota: Este es el cuerpo de la nota"
}
],
"wolkvox_fecha_creacion": "",
"wolkvox_usuario_creacion": "",
"wolkvox_fecha_modificacion": "",
"wolkvox_usuario_modificacion": "",
"case_dependent": "",
"case_dependentOf": null,
"wolkvox_origen": null,
"wolkvox_ip_address": "",
"files": [],
"caseExpired": true,
"companyId": "",
"companyName": "",
"wolkvox_id": ""
},
{
"idCase": "",
"caseType": "",
"priority": {
"value": ,
"name": ""
},
"status": {
"value": "",
"name": ""
},
"description_case": "",
"closeDate": "",
"contactId": "",
"contact": "",
"contactEmail": "",
"contactTel": {
"value": "",
"country": "",
"code": ""
},
"contactIdentification": "",
"namecompany": "",
"owner": {
"id": "",
"level": null,
"name": "",
"mail": "",
"tel": ""
},
"prefix": "",
"responsible": {
"id": "",
"name": "",
"mail": "",
"group":
},
"groupsOwner": [],
"idPrefijo": "",
"timeEstimated": "",
"reOpened": ,
"form": {
"valor": "",
"Nombre": "",
"canal": "",
"asunto": ""
},
"history": [
{
"date": "",
"type": "note",
"user": "",
"message": "Añadió la nota: Este es el cuerpo de la nota"
},
{
"date": "",
"type": "note",
"user": "",
"message": "Añadió la nota: Este es el cuerpo de la nota"
},
{
"date": "",
"level": "",
"message": "",
"user": ""
},
{
"date": "",
"message": "",
"user": ""
},
{
"date": "",
"type": "note",
"user": "",
"message": "Añadió la nota: Este es el cuerpo de la nota"
},
{
"date": "",
"type": "note",
"user": "",
"message": ""
},
{
"color": "",
"date": "",
"level": "",
"tag": "",
"user": "",
"message": ""
},
{
"color": "",
"date": "",
"level": "",
"tag": "",
"user": "",
"message": ""
}
],
"wolkvox_fecha_creacion": "",
"wolkvox_usuario_creacion": "",
"wolkvox_fecha_modificacion": "",
"wolkvox_usuario_modificacion": "",
"case_dependent": "",
"case_dependentOf": null,
"wolkvox_origen": null,
"wolkvox_ip_address": "",
"files": [],
"caseExpired": true,
"companyId": "",
"companyName": "",
"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
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