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 management

< / >

Query management

URL:

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

Descripción:

This API allows querying the obligation of a record in the collections module.

How it works?:

This API works through a “raw” type body and a GET request, which requires the following fields for its proper operation:

– In the request headers, the following is required:

Wolkvox-Token

– In the request body, the following is required:

operation
obligation
wolkvox-id

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”
field	It is the field to refer to for the search.	“field”: “customer_id”
value	It is the value to search for.	“value”: “123”

REQUEST

				
					$curl = curl_init();

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

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

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

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

print(response.text)

RESPONSE

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”
tipifycation_code	Codification code.
tipifycation_desc	Classification description.
module	CRM module. In this case, being an API for collections, it should point to the “collections” module.	“module”: “collections”
id_customer	Customer identification number.
customer_id	Additional customer identification.
wolkvox_idRecord	Identification code of the record in the collections module.
wolkvox_idCall	Call identification number.
client_name	Customer name.
client_lastname	Last name of the customer.
client_type_document	Type of customer identification document.
client_telephone	Customer’s phone number.
agent_name	Agent’s name who carried out the management.
agent_id	Agent’s extension number.
type_interaction	Type of interaction used to manage the record.
time	Interaction time.
date	Interaction date.
campaign_id	Campaign identification code.
wolkvox_idCustomer	Wolkvox application customer identification number.
wolkvox_phoneCall	Wolkvox application phone number.
wolkvox_CrmPhoneCall	Phone number in the wolkvox CRM application call.
obligation	Obligation reference name.
wolkvox_usuario_creacion	User who created the management.
wolkvox_origen	Indicates from where the management was inserted.
wolkvox_ip_address	Indicates the IP from which the request to insert the management was made.
wolkvox_owner	It is a set of data about the owner of the management. It displays the user (user), name (nombre), identification number (id), and email address (email).
wolkvox_id	Record Identification Code.

				
					{
    "code": "200",
    "error": "null",
    "msg": "1 records were are found",
    "data": [
        {
            "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": "",
            "wolkvox_usuario_creacion": "",
            "wolkvox_origen": "",
            "wolkvox_ip_address": "",
            "wolkvox_owner": {
                "user": "",
                "nombre": "",
                "id": "",
                "email": ""
            },
            "wolkvox_id": ""
        }
    ]
}

Possible error codes

< / >