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

< / >

Query En

Query

URL:

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

Description:

The search API allows us to search for records in the configured modules of our CRM by sending parameters.

How it works?:

This API works through a POST request, which requires the following fields for its proper functioning:

– The request headers require the following information:

Wolkvox-Token

– In the request body, the following information is required:

operation
module
field
value

REQUEST

KEY	DESCRIPTION	Example
Wolkvox-Token	The token is configured by the client on the CRM page.	{token}
operation	It is the name of the CRM operation.	{operation_name}
field	It is the CRM field that we will use for filtering.	namecontact
value	It is the search criteria.	Jhon Doe
module	Name of the module to query.	contacts

				
					<?php

$curl = curl_init();

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

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location --request GET 'https://{{wolkvox_server}}/server/API/v2/custom/query.php' \
--header 'Wolkvox-Token: {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "operation":"{{operacion}},
    "module":"{{module}}",
    "field":"{{field}}",
    "value":"{{value}}"
}'

				
					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    \"field\":\{"field\"},\r\n    \"value\":\{"value\"}\r\n}");
Request request = new Request.Builder()
  .url("https://{{wolkvox_server}}/server/API/v2/custom/query.php")
  .method("GET", 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/custom/query.php"

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

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

print(response.text)

Possible error codes

< / >

Query En

Query

REQUEST

COLOMBIA

ARGENTINA

BRAZIL

CHILE

SPAIN

UNITED STATES

GUATEMALA

MEXICO

DOMINICAN REPUBLIC

PERU