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

Insertar registros en Cobranzas y sus obligaciones

< / >

Insert

Insertar registros en Cobranzas y sus obligaciones

URL:

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

Descripción:

Esta API permite la inserción masiva de registros en el módulo de Cobranzas de wolkvox CRM, incluyendo expedientes y sus respectivas obligaciones. Un expediente representa la información de un cliente, mientras que las obligaciones son los compromisos de pago asociados a ese cliente.

Esta API está diseñada para facilitar la carga y actualización de grandes volúmenes de datos de manera estructurada y eficiente.

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

¿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”: “modulotest03”
collections	Lista de expedientes (clientes) a insertar con sus respectivas obligaciones.
Identification	Identificación única del cliente. Este campo es obligatorio.	“Identification”: “12345”
Name	Nombre del cliente. Este campo es obligatorio.	“Name”: “John Doe”
Email	Correo electrónico del cliente. Este campo es obligatorio.	“Email”: “[email protected]”
Telephone	Número de teléfono del cliente. Este campo es obligatorio.	“Telephone”: “31949”
Address	Dirección del cliente.	“Address”:”Avenida 12 calle 43″
campo_personalizado	Se pueden incluir campos personalizados existentes en el módulo de Cobranzas.	“campo_personalizado”:”valor el campo personalizado”
id	Identificación única de la obligación. Este campo es obligatorio.	“id”: “02”
name	Nombre de la obligación. Este campo es obligatorio.	“name”: “oblg2”
total_balance	Saldo total de la obligación.	“total_balance”: “1000”
expiring_date	Fecha de vencimiento (YYYY-MM-DD).	“expiring_date”: “2025-02-03”
days_delay	Días de mora.	“days_delay”: “33”
portfolio_type	Tipo de portafolio al que pertenece la obligación.	“portfolio_type”:”TestPortfolio”
last_pay	Último pago realizado.	“last_pay”:”500″
last_pay_date	Fecha del último pago (YYYY-MM-DD).	“last_pay_date”:”2025-01-09″
balance_payment	Saldo pendiente de pago.	“balance_payment”:”500″
campo_personalizado_en_la_obligacion	Se pueden incluir campos personalizados existentes en el módulo de Obligaciones.	“campo_personalizado_en_la_obligacion”:”valor el campo personalizado”

REQUEST

				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{crm_server}}/server/API/v2/collections/massiveCollections.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": "",
    "collections": [
        {
            "Identification": "",
            "Name": "",
            "Email": "",
            "Telephone": "",
            "Address": "",
            "Obligations": [
                {
                    "id": "",
                    "name": "",
                    "total_balance": "",
                    "expiring_date": "",
                    "days_delay": "",
                    "portfolio_type": "",
                    "last_pay": "",
                    "last_pay_date": "",
                    "balance_payment": ""
                }
            ]
        },
        {
            "Identification": "",
            "Name": "",
            "Email": "",
            "Telephone": "",
            "Address": "",
            "Obligations": [
                {
                    "id": "",
                    "name": "",
                    "total_balance": "",
                    "expiring_date": "",
                    "days_delay": "",
                    "portfolio_type": "",
                    "last_pay": "",
                    "last_pay_date": "",
                    "balance_payment": ""
                }
            ]
        }
    ]
}',
  CURLOPT_HTTPHEADER => array(
    'Wolkvox-Token: {{Wolkvox-Token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location --globoff 'https://{{crm_server}}/server/API/v2/collections/massiveCollections.php' \
--header 'Wolkvox-Token: {{Wolkvox-Token}}' \
--data '{
    "operation": "",
    "collections": [
        {
            "Identification": "",
            "Name": "",
            "Email": "",
            "Telephone": "",
            "Address": "",
            "Obligations": [
                {
                    "id": "",
                    "name": "",
                    "total_balance": "",
                    "expiring_date": "",
                    "days_delay": "",
                    "portfolio_type": "",
                    "last_pay": "",
                    "last_pay_date": "",
                    "balance_payment": ""
                }
            ]
        },
        {
            "Identification": "",
            "Name": "",
            "Email": "",
            "Telephone": "",
            "Address": "",
            "Obligations": [
                {
                    "id": "",
                    "name": "",
                    "total_balance": "",
                    "expiring_date": "",
                    "days_delay": "",
                    "portfolio_type": "",
                    "last_pay": "",
                    "last_pay_date": "",
                    "balance_payment": ""
                }
            ]
        }
    ]
}'

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "{\r\n    \"operation\": \"\",\r\n    \"collections\": [\r\n        {\r\n            \"Identification\": \"\",\r\n            \"Name\": \"\",\r\n            \"Email\": \"\",\r\n            \"Telephone\": \"\",\r\n            \"Address\": \"\",\r\n            \"Obligations\": [\r\n                {\r\n                    \"id\": \"\",\r\n                    \"name\": \"\",\r\n                    \"total_balance\": \"\",\r\n                    \"expiring_date\": \"\",\r\n                    \"days_delay\": \"\",\r\n                    \"portfolio_type\": \"\",\r\n                    \"last_pay\": \"\",\r\n                    \"last_pay_date\": \"\",\r\n                    \"balance_payment\": \"\"\r\n                }\r\n            ]\r\n        },\r\n        {\r\n            \"Identification\": \"\",\r\n            \"Name\": \"\",\r\n            \"Email\": \"\",\r\n            \"Telephone\": \"\",\r\n            \"Address\": \"\",\r\n            \"Obligations\": [\r\n                {\r\n                    \"id\": \"\",\r\n                    \"name\": \"\",\r\n                    \"total_balance\": \"\",\r\n                    \"expiring_date\": \"\",\r\n                    \"days_delay\": \"\",\r\n                    \"portfolio_type\": \"\",\r\n                    \"last_pay\": \"\",\r\n                    \"last_pay_date\": \"\",\r\n                    \"balance_payment\": \"\"\r\n                }\r\n            ]\r\n        }\r\n    ]\r\n}");
Request request = new Request.Builder()
  .url("https://{{crm_server}}/server/API/v2/collections/massiveCollections.php")
  .method("POST", body)
  .addHeader("Wolkvox-Token", "{{Wolkvox-Token}}")
  .build();
Response response = client.newCall(request).execute();

				
					import requests

url = "https://{{crm_server}}/server/API/v2/collections/massiveCollections.php"

payload = "{\r\n    \"operation\": \"\",\r\n    \"collections\": [\r\n        {\r\n            \"Identification\": \"\",\r\n            \"Name\": \"\",\r\n            \"Email\": \"\",\r\n            \"Telephone\": \"\",\r\n            \"Address\": \"\",\r\n            \"Obligations\": [\r\n                {\r\n                    \"id\": \"\",\r\n                    \"name\": \"\",\r\n                    \"total_balance\": \"\",\r\n                    \"expiring_date\": \"\",\r\n                    \"days_delay\": \"\",\r\n                    \"portfolio_type\": \"\",\r\n                    \"last_pay\": \"\",\r\n                    \"last_pay_date\": \"\",\r\n                    \"balance_payment\": \"\"\r\n                }\r\n            ]\r\n        },\r\n        {\r\n            \"Identification\": \"\",\r\n            \"Name\": \"\",\r\n            \"Email\": \"\",\r\n            \"Telephone\": \"\",\r\n            \"Address\": \"\",\r\n            \"Obligations\": [\r\n                {\r\n                    \"id\": \"\",\r\n                    \"name\": \"\",\r\n                    \"total_balance\": \"\",\r\n                    \"expiring_date\": \"\",\r\n                    \"days_delay\": \"\",\r\n                    \"portfolio_type\": \"\",\r\n                    \"last_pay\": \"\",\r\n                    \"last_pay_date\": \"\",\r\n                    \"balance_payment\": \"\"\r\n                }\r\n            ]\r\n        }\r\n    ]\r\n}"
headers = {
  'Wolkvox-Token': '{{Wolkvox-Token}}'
}

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

print(response.text)

RESPONSE

KEY	DESCRIPCIÓN	TIPO
code	Indica el código de estado de la respuesta.	String
success	true si la operación fue exitosa, false si hubo errores.	Boolean
total_records_received	Cantidad total de expedientes recibidos en la solicitud.	Integer
successful_inserts	Cantidad de expedientes insertados correctamente.	Integer
failed_count	Es la identificación del prefijo del caso.	Integer
total_processed	Cantidad total de registros procesados.	Integer
failed_Sumary	Detalles de los registros fallidos, en caso de errores.	Array

				
					{
    "code": "200",
    "success": true,
    "summary": {
        "total_records_received": ,
        "successful_inserts": ,
        "failed_count": ,
        "total_processed": ,
        "failed_Sumary": []
    }
}

Posibles códigos de error