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 gestión

< / >

Consultar gestión

URL:

https://{{crm_server}}/server/API/v2/collections/queryGestion.php

Descripción:

Esta API permite consultar la obligación de un registro del módulo de cobranzas.

¿Cómo funciona?:

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:

Wolkvox-Token

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

operation
obligation
wolkvox-id

¿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 a referenciar para la búsqueda.	“field”: “customer_id”
value	Es el valor a buscar.	“value”: “123”
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/collections/queryGestion.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": "",
    "field": "",
    "value": ""
}',
  CURLOPT_HTTPHEADER => array(
    'Wolkvox-Token: {{Wolkvox-Token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location --request POST 'https://{{wolkvox_server}}/server/API/v2/collections/queryGestion.php' \
--header 'Wolkvox-Token: {{Wolkvox-Token}}' \
--header 'Content-Type: application/json' \
--data '{
    "operation": "",
    "field": "",
    "value": ""
}'

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n    \"operation\": \"\",\r\n    \"field\": \"\",\r\n    \"value\": \"\"\r\n}");
Request request = new Request.Builder()
  .url("https://{{wolkvox_server}}/server/API/v2/collections/queryGestion.php")
  .method("POST", body)
  .addHeader("Wolkvox-Token", "{{Wolkvox-Token}}")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

				
					import requests
import json

url = "https://{{wolkvox_server}}/server/API/v2/collections/queryGestion.php"

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

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

print(response.text)

RESPONSE

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”
tipifycation_code	Código de tipificación.
tipifycation_desc	Descripción de la tipificación.
module	Módulo del crm. En este caso al ser una API para las cobranzas, debe apuntar al módulo “collections”.	“module”: “collections”
id_customer	Número de identificación del cliente.
customer_id	Identificación adicional del cliente.
wolkvox_idRecord	Código de identificación del registro en el módulo de cobranzas (collections).
wolkvox_idCall	Número de identificación de la llamada.
client_name	Nombre del cliente.
client_lastname	Apellido del cliente.
client_type_document	Tipo de documento de identificación del cliente.
client_telephone	Teléfono del cliente.
agent_name	Nombre del agente que realizó la gestión.
agent_id	Número de extensión del agente.
type_interaction	Tipo de interacción con la que se gestionó el registro.
time	Tiempo de interacción.
date	Fecha de la interacción.
campaign_id	Código de identificación de la campaña.
wolkvox_idCustomer	Número de identificación del cliente en el aplicativo wolkvox.
wolkvox_phoneCall	Número de teléfono en el aplicativo wolkvox.
wolkvox_CrmPhoneCall	Número de teléfono en la llamada del aplicativo wolkvox CRM.
obligation	Nombre de referencia de la obligación.
wolkvox_usuario_creacion	Usuario que creó la gestión.
wolkvox_origen	Indica desde dónde se insertó la gestión.
wolkvox_ip_address	Indica la IP desde la cual se hizo la solicitud de inserción de la gestión.
wolkvox_owner	Es un conjunto de datos acerca del dueño de la gestión. Muestra el usuario (user), nombre (nombre), número de identificación (id) y el correo electrónico (email).
wolkvox_id	Código de identificación del registro.

				
					{
    "code": "200",
    "error": "null",
    "msg": "1 records were are found",
    "data": [
        {
            "tipifycation_code": "",
            "tipifycation_desc": "",
            "module": "",
            "id_customer": "",
            "customer_id": "",
            "wolkvox_idRecord": "",
            "wolkvox_idCall": "",
            "client_name": "",
            "client_lastname": "",
            "client_type_document": "",
            "client_telephone": "",
            "agent_name": "",
            "agent_id": "",
            "type_interaction": "",
            "time": "",
            "date": "",
            "campaign_id": "",
            "tipification_code": "",
            "tipification_description": "",
            "wolkvox_idCustomer": "",
            "wolkvox_phoneCall": "",
            "wolkvox_CrmPhoneCall": "",
            "obligation": "",
            "wolkvox_usuario_creacion": "",
            "wolkvox_origen": "",
            "wolkvox_ip_address": "",
            "wolkvox_owner": {
                "user": "",
                "nombre": "",
                "id": "",
                "email": ""
            },
            "wolkvox_id": ""
        }
    ]
}

Posibles códigos de error