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

< / >

Query Cases

URL:

https://{{wolkvox_server}}/server/API/v2/cases/queryCases.php

Description:

The search cases API allows us to search for records exclusively in the configured module by sending specific parameters.

How it works?:

This API is consumed using the POST method.
The request header requires “Wolkvox-Token” with the token generated in your operation.
The API URLs contain a placeholder {{crm_server}} that needs to be replaced with the specific server where the customer operation is located. Currently, the available servers are: “sv0001.crmvox.com” and “crm.wolkvox.com”.
The body should be built in “raw” format.
The request body requires: “operation”, “field”, y “value”.

– In the request headers, the following is required:

Wolkvox-Token

How to use the URL?

The API URL contains a placeholder {{crm_server}} that must be replaced with the specific server where the customer operation is located.

Available servers:

Currently, the available servers are:

sv0001.crmvox.com
crm.wolkvox.com

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.	{token}
operation	It is the name of the CRM operation.	{operation_name}
field	This is the CRM field we will use to filter. You can use the following variables to filter as desired: “status”, “priority”, “email contact”, “name contact”, “contact wolkvox id”, “contact identification”, “contact phone”, “description”, “idCase”, “idPrefijo”, “companyName”, “company name”, “company id”, “prefix”, “reopened”, “responsible name”, “responsible user”, “responsible id”, “owner name”, “owner user”, “owner id”, “solution”, “wolkvox-id”, “type case”, “case expired” and “reason”.	status
value	This is the search criteria. If you decide to search by case type, you can use “Request” for requests, “Complaints” for complaints, “Claims” for claims, and “Suggestions” for suggestions.	open

				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{wolkvox_server}}/server/API/v2/cases/queryCases.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}}",
    "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 POST 'https://{{wolkvox_server}}/server/API/v2/cases/queryCases.php' \
--header 'Wolkvox-Token: {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "operation":"{{operation}}",
    "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    \"field\":\"{{field}}\",\r\n    \"value\":\"{{value}}\"\r\n}\r\n\r\n");
Request request = new Request.Builder()
  .url("https://{{wolkvox_server}}/server/API/v2/cases/queryCases.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/cases/queryCases.php"

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

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

print(response.text)

RESPONSE

KEY	DESCRIPTION	TYPE
page	Current page number of results.	Int
Total records	Total number of records found in the query.	Int
Total pages	Total number of result pages available.	Int
msg	It is an informative message that describes the response.	String
data	It is the set of information obtained as a result of having made the request.	String
contactId	It is the identification number of the contact record in Wolkvox CRM.	“contactId”: “64d2ccxx”
contact	It is the name of the contact record.	“contact”: “[email protected]”
contactEmail	This is the email address of the contact record.	“contactEmail”: “[email protected]”
contactTel	It is the phone number from the contact record.	“contactTel”: 0000000000
contactIdentification	This is the contact’s identity document number.	“contactIdentification”: “”
namecompany	It is the company related to the case.	“namecompany”: “”
owner	Please provide the ID (identification number), level (user level), name, email, and phone number of the case owner.	“owner”: { “id”: “”, “level”: “”, “name”: “”, “mail”: “”, “tel”: “” }
prefix	Indicate the case prefix.	“prefix”: “PET”
responsible	Please provide the ID (identification number), name, email, phone number, and group (if applicable, otherwise “false”) of the case manager.	“responsible”: { “id”: “”, “name”: “”, “mail”: “”, “tel”: “”, “group”: }
groupsowner	Indicate the property owner groups for the case.	“groupsOwner”: []
idPrefijo	Indicate the prefix plus the case number.	“idPrefijo”: “PET-2132xxcd”
timeEstimated	Please indicate the estimated date and time for closing the case.	“timeEstimated”: “2023-08-08 14:00:07”
reOpened	Indicate whether the case was reopened (true) or not (false).	“reOpened”: false
form	This lists the additional fields to the default fields that come in a case module.	“form”: { “Additional field 1”: “” }
history	This lists the history of actions performed in the log. It may include the date, type of action, the user who performed the action, the system message about the action performed, and the element on which the action was performed.	“history”: [ { “date”: “2023/8/8 15:59:5”, “type”: “note”, “user”: “Admin – Admin – usuario@modulodeprueba”, “message”: “Añadió la nota: Esto es una nota 2.0”, }, { “date”: “2023/9/29 14:25:29”, “level”: “”, “tag”: “status”, “user”: “Admin – Admin – usuario@modulodeprueba”, “message”: “Cambió el estado de undefined Para In progress” } ]
wolkvox_fecha_creacion	The date and creation of the case.	“wolkvox_fecha_creacion”: “2023-08-08 13:30:07”
wolkvox_usuario_creacion	Indicate the user who created the case. It may appear as API@ to indicate that the case was created from an API.	“wolkvox_usuario_creacion”: “API@modulodeprueba”
wolkvox_fecha_modificacion	Indicate the date and time of the last modification of the case.	“wolkvox_fecha_modificacion”: “2023-09-29 14:25:28”
wolkvox_usuario_modificacion	Indicate the date and time of the last modification of the case.	“wolkvox_usuario_modificacion”: “usuario@modulodeprueba”
case_dependent	Indicate whether the case is dependent or independent.	“case_dependent”: “independent”
wolkvox_origen	Indicate the origin of the case’s creation.	“wolkvox_origen”: “PostmanRuntime/7.32.3”
wolkvox_ip_address	Provide the IP address associated with the case creation.	“wolkvox_ip_address”: “1bb.ccc.ddd.ff”
files	List the files attached to the case. Include the file name and the URL.	“files”: [ { “name”: “archivo1.jpg”, “url”: “https://crm.wolkvox.com/…” } ]
nameContact	Name of the contact associated with the case.	“nameContact”: “”
caseExpired	Indicate whether the case has expired (true) or not (false).	“caseExpired”: true
wolkvox_id	It is the unique identifier of the case record.	“wolkvox_id”: “64d2dcsvb”

				
					{
    "code": "200",
    "error": "null",
    "msg": "x records were are found",
    "data": []
}

Possible error codes

< / >

Query Cases

Query Cases

REQUEST

RESPONSE

COLOMBIA

ARGENTINA

BRAZIL

CHILE

SPAIN

UNITED STATES

GUATEMALA

MEXICO

DOMINICAN REPUBLIC

PERU