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

Cases Insert En

< / >

Cases Insert

URL:

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

Description:

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

How does it work?:

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 “form-data” format.
The request body requires: “operation”, “case-type”, “responsible”, “owner”, “contact”, “description”, “status” and “priority”.

– 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}
case-type	It’s the type of case. You can use “Request”, “Complaints”, “Claims”, and “Suggestions”. You can also place custom case types that you have previously created in your case module.	Request
responsible	He is responsible for the case. This data for each user is extracted from the “Wolkvox Email” column of the list of users created in your operation. Before consuming this API, the user should already be created.	{user@operation}
owner	They are the owner of the case. This data for each user is extracted from the “Wolkvox Email” column in the list of users created in their operation. Before consuming this API, the user should already be created.	{user@operation}
contact	This is the contact or client related to the case. The contact is identified by the email that was assigned to the client in the “Contact Email” column in the contact module of your operation. Before consuming this API, the contact should already be created.	{user@operation}
description	It is the case description.	Case created through API.
status	This is the state of the case. The value you enter in this field must already be created in the module and for the specified case type.	open
priority	This is the priority of the case. The value you enter in this field must already be created in the module and for the specified case type.	low
form	These are the custom fields that we have parameterized in our CRM. First comes the field name (name_field) and then the value that will be entered in the field (value_field). The custom fields are separated by a comma.	{“name_field”: “value_field”}
solution	This field is required if the assigned case status has the condition “Closed”. The purpose of this field is to define the outcome of the case. That is, this is where the solution to the case goes. Therefore, it is not required to fill out this field when the assigned case status is related to the condition “Open”.	{case_solution}
file	These are the attached files. The supported formats are as follows: .xlsx, .csv, .pdf, .jpg, .png, .docx, .mp4, .mp3, .wmv, .wma, .wap, .doc, .jpeg, .avi, .bmp, .bpm, .avi, .mov, .tiff, .docx, .zip, .7z, .rar

				
					<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{wolkvox_server}}/server/API/v2/cases/insert.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 => array('operation' => '{operation}','case-type' => '{case-type}','responsible' => '{responsible}','owner' => '{owner}','contact' => '{contact}','description' => '{description}','status' => '{status}','priority' => '{baja}','form' => '{}'),
  CURLOPT_HTTPHEADER => array(
    'Wolkvox-Token: {Wolkvox-Token}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location --request POST 'https://{{wolkvox_server}}/server/API/v2/cases/insert.php' \
--header 'Wolkvox-Token: {Wolkvox-Token}' \
--form 'operation="{operation}"' \
--form 'case-type="{case-type}"' \
--form 'responsible="{responsible}"' \
--form 'owner="{owner}"' \
--form 'contact="{contact}"' \
--form 'description="{description}"' \
--form 'status="{status}"' \
--form 'priority="{priority}"' \
--form 'form="{}"'

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
  .addFormDataPart("operation","{operation}")
  .addFormDataPart("case-type","{case-type}")
  .addFormDataPart("responsible","{responsible}")
  .addFormDataPart("owner","{owner}")
  .addFormDataPart("contact","{contact}")
  .addFormDataPart("description","{description}")
  .addFormDataPart("status","{status}")
  .addFormDataPart("priority","{priority}")
  .addFormDataPart("form","{}")
  .build();
Request request = new Request.Builder()
  .url("https://{{wolkvox_server}}/server/API/v2/cases/insert.php")
  .method("POST", body)
  .addHeader("Wolkvox-Token", "{Wolkvox-Token}")
  .build();
Response response = client.newCall(request).execute();

				
					import requests

url = "https://{{wolkvox_server}}/server/API/v2/cases/insert.php"

payload={'operation': '{operation}',
'case-type': '{case-type}',
'responsible': '{responsible}',
'owner': '{owner}',
'contact': '{contact}',
'description': '{description}',
'status': '{status}',
'priority': '{priority}',
'form': '{}'}
files=[

]
headers = {
  'Wolkvox-Token': '{Wolkvox-Token}',
}

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

print(response.text)

RESPONSE

KEY	DESCRIPTION	EXAMPLE
code	Indicate the status code of the response.	“code”: 200
error	Provide details about the error that occurred during the request.	“error”: “null”
msg	Show a descriptive message about the result of the request.	“msg”: “Succesfully edit record”
data	It is the set of information obtained as a result of having made the request.	“data”: { “wolkvox_id”: “64cb” }
wolkvox_id	This is the record identifier in the module.	“wolkvox_id”: “64cb”
idPrefijo	This is the case prefix identification.	“idPrefijo”: “”

				
					{
    "code":200,"error":"null","msg":"Succesfully create record","data":{"wolkvox_id":"","idPrefijo":""}
}

Possible error codes

< / >

Cases Insert

Cases Insert

REQUEST

RESPONSE

COLOMBIA

ARGENTINA

BRAZIL

CHILE

SPAIN

UNITED STATES

GUATEMALA

MEXICO

DOMINICAN REPUBLIC

PERU