fbpx

< / >

Consultar gestión

Consultar gestión

URL:

https://{{wolkvox_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 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
  • obligation
  • wolkvox-id

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”

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

				
			

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

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