fbpx

< / >

Insertar gestión

Insertar gestión

URL:

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

Descripción:

Esta API permite insertar gestiones en un registro de un módulo de cobranza.

¿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
  • wolkvox-id
  • fields

Nota: Dentro de “fields”, el campo principal para referenciar el registro donde deseas insertar la gestión es “wolkvox_idRecord”. Los campos obligatorios son: “tipifycation_code”, “tipifycation_desc”, “module” y “wolkvox_idRecord”

El resto de campos dentro de “fields” son opcionales y dependen de tus necesidades de inserción de la gestión.

¿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”
fields
Objeto JSON que contiene un conjunto de atributos que describen la gestión a insertar.
“fields”: {}
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.

REQUEST

				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{wolkvox_server}}/server/API/v2/collections/insertGestion.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": "",
    "fields": {
        "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": ""
    }
}',
  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
code
Indica el código de estado de la respuesta.
“code”: 200
error
Proporciona detalles sobre el error que ocurrió durante la solicitud.
“error”: “null”
msg
Muestra un mensaje descriptivo sobre el resultado de la solicitud.
“msg”: “Succesfully edit record”
data
Es el conjunto de información obtenido como resultado de haber hecho la solicitud.
“data”: { “wolkvox_id”: “” }
				
					{
    "code": 200,
    "error": "null",
    "msg": "Succesfully create record",
    "data": {
        "wolkvox_id": "123cb"
    }
}
				
			
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