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 dates - crmvox

< / >

Query Dates

URL:

https://{{wolkvox_server}}/server/API/v2/custom/queryDates.php

Description:

The date search API allows us, by sending parameters, to search for records in the parameterized modules of our CRM within a defined date range.

¿How it works?

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

– In the request headers, the following is required:

Wolkvox-Token

– In the request body, the following is required:

operation
module
date
from
to

As a requirement for the date range search to work correctly, you must set the value of the ‘date‘ field to ‘true‘.

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”
module	Module name for querying.	contacts
date	It is a conditional field to determine the date range search. This should be set to TRUE to perform the date-based query.	“date”: true
from	It is the initial range to generate the query.	“from”: “2023-09-01 00:00”
to	It is the final range to generate the query.	“to”: “2023-09-30 00:00”
limit	This field is optional and refers to the limit of records you want to see in the response.	“limit”: “2”

REQUEST

				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{wolkvox_server}}/server/API/v2/custom/queryDates.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":"{{operation}}",
    "module":"{{module}}",
    "date": {{date}},
    "from": "{{from}}",
    "to": "{{to}}"
    
 }',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Wolkvox-Token: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location --request POST 'https://{{wolkvox_server}}/server/API/v2/custom/queryDates.php' \
--header 'Content-Type: application/json' \
--header 'Wolkvox-Token: {{token}}' \
--data-raw '{
    "operation":"{{operation}}",
    "module":"{{module}}",
    "date": {{date}},
    "from": "{{from}}",
    "to": "{{to}}"
    
 }'

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

				
					import requests
import json

url = "https://{{wolkvox_server}}/server/API/v2/custom/queryDates.php"

payload = json.dumps({
  "operation": "{{operation}}",
  "module": "{{module}}",
  "date": {{date}},
  "from": "{{from}}",
  "to": "{{to}}"
})
headers = {
  'Content-Type': 'application/json',
  'Wolkvox-Token': '{{token}}',
}

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

print(response.text)

RESPONSE

It provides all the fields created in the module, plus the default fields, which are the following:

KEY	DESCRIPTION	EXAMPLE
wolkvox_usuario_creacion	It is the user who created the record.	“wolkvox_usuario_creacion”: “admin@testmodule”
wolkvox_fecha_creacion	It is the name of the CRM operation	“wolkvox_fecha_creacion”: “2023-09-29 10:59:54”
wolkvox_origen	It indicates where the record was created from.	“PostmanRuntime/7.33.0 – /server/API/v2/custom/insert.php”
wolkvox_ip_address	It indicates the public IP from which the record was created.	“wolkvox_ip_address”: “xxx.ccc.ddd.ee – v2”
wolkvox_owner	It displays a set of data about the owner of the record. This dataset includes the username (user), name (nombre), ID number (id), and email address (email).	“wolkvox_owner”: { “user”: “api”, “nombre”: “api”, “id”: “api”, “email”: “api” }
wolkvox_id	It is the identification number of the record in Wolkvox CRM.	“wolkvox_id”: “6cvvbbxx”

				
					[
    {
        "wolkvox_usuario_creacion": "",
        "wolkvox_fecha_creacion": "",
        "wolkvox_origen": "",
        "wolkvox_ip_address": "",
        "wolkvox_owner": {
            "user": "",
            "nombre": "",
            "id": "",
            "email": ""
        },
        "wolkvox_id": ""
    }
]

Possible error codes

< / >

Query Dates

Query Dates

REQUEST

REQUEST

RESPONSE

COLOMBIA

ARGENTINA

BRAZIL

CHILE

SPAIN

UNITED STATES

GUATEMALA

MEXICO

DOMINICAN REPUBLIC

PERU