WHY WOLKVOX? OMNICHANNEL PLATFORM WOLKVOX CRM CHATBOTS AND VOICEBOTS MANUALS

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 SPAIN Madrid +34 (910) 601 691 MEXICO Ciudad de México +52 (55) 8526 36 34 BRASIL Brasilia +55 (61) 9836 4127 São Paulo +55 (12) 9811 155 83 UNITED STATES New York +1 (914) 373 71 36 DOMINICAN REPUBLIC Santo Domingo +1 (829) 249 69 68 CHILE Santiago de Chile +56 (2) 240 533 89 GUATEMALA Ciudad de Guatemala +502 (2) 314 1344 PERU Lima +51 (1) 644 91 39

Query obligation

< / >

Query obligation

URL:

https://{{wolkvox_server}}/server/API/v2/collections/queryObligation.php

Description:

This API provides the functionality to search for obligations in the collections module. It allows you to search and retrieve detailed information about obligations associated with records in your operation.

¿How it works?

This API operates through a ‘raw‘ type body and a GET request, which requires the following fields for its proper functioning:

– The request headers require:

Wolkvox-Token

– In the request body, it is required

operation
obligation
wolkvox-id

How to determine the CRM server?

Access the CRM homepage using the link: https://crm.wolkvox.com/
Log in using your CRM credentials.
Once you have logged in and are on the homepage of your CRM platform, observe the address bar of your web browser. The URL in this bar indicates the server where your operation is hosted.
Replace {{crm_server}} in the original URL with the specific URL of your CRM server to ensure that the API points correctly to your CRM instance.

Important Notice: Access Route Update

Starting September 1, 2024, new URLs will be implemented to access the wolkvox CRM platform. The current URLs will coexist with the new ones until November 30, 2024, after which they will be disabled.

New URLs:

From “https://sv0001.crmvox.com” to “https://crm0001.wolkvox.com“

From “https://sv0000.crmvox.com” to “https://crm0000.wolkvox.com“

Please ensure you update your integrations and automations before November 30, 2024, to avoid service interruptions.

REQUEST

KEY	DESCRIPTION	EXAMPLE
Wolkvox-Token	It is the token configured by the client on the CRM page.	A8K3J7F2
operation	It is the name of the CRM operation.	“operation”:”testmodule”
obligation	It is the obligation identifier.	“obligation”: “6669999 API”
wolkvox_id	It is the identifier of the records in collections.	“wolkvox_id”: “61fa3”

REQUEST

				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{wolkvox_server}}/server/API/v2/collections/queryObligation.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": "",
    "obligation": "",
    "wolkvox_id": ""
}',
  CURLOPT_HTTPHEADER => array(
    'Wolkvox-Token: {{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/queryObligation.php' \
--header 'Wolkvox-Token: {{token}}' \
--header 'Content-Type: application/json' \
--data '{
    "operation": "",
    "obligation": "",
    "wolkvox_id": ""
}'

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n    \"operation\": \"\",\r\n    \"obligation\": \"\",\r\n    \"wolkvox_id\": \"\"\r\n}");
Request request = new Request.Builder()
  .url("https://{{wolkvox_server}}/server/API/v2/collections/queryObligation.php")
  .method("POST", body)
  .addHeader("Wolkvox-Token", "{{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/queryObligation.php"

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

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

print(response.text)

RESPONSE

KEY	DESCRIPTION	EXAMPLE

id	Identification code of the obligation in the indicated record.	“id”: “obl1”
name	Obligation name.	“name”: “Invoice 12345 – Pending Payment”
total_balance	It is the total balance.	“total_balance”: “10000”
portfolio_type	It is the associated portfolio type.	“portfolio_type”: “VIP Client”
last_pay	Indicates the amount of the last associated payment.	“last_pay”: “2000”
last_pay_date	Indicates the date of the last associated payment.	“last_pay_date”: “06-06-2023”
expiring_date	Indicates the due date.	“expiring_date”: “07-07-2023”
days_delay	Indicates the number of days overdue.	“days_delay”: “90”
form	It is a dataset representing additional fields (in the obligations) that were created as complementary to the default ones.	“form”: [ { “name”: “Titulation”, “value”: “titulation value” }, { “name”: “Frequency”, “value”: “Frequented” } ]

				
					{
    "code": "200",
    "error": "null",
    "msg": "x records were are found",
    "data": [
        {
            "id": "",
            "name": "",
            "total_balance": "",
            "portfolio_type": "",
            "last_pay": "",
            "last_pay_date": "",
            "expiring_date": "",
            "days_delay": "",
            "form": [
                {
                    "name": "",
                    "value": ""
                }
            ]
        }
    ]
}

Posibles códigos de error

< / >