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

Insert Cases with Attachments

< / >

Insert

Insert Cases with Attachments

URL:

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

Description:

The following API configuration allows us to add cases with attachments.

How does it work?

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

– The following headers are required in the request:

Wolkvox-Token: {{token}}
Content-Type: application/json

– In the request body, the following fields are required:

operation
case-type
responsible
owner
contact
description
form
status
priority
attachments

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.

Insert attachments in base64

The attachments field allows you to send attachments in base64 format. This field accepts a list of base64 strings representing the files you want to attach:

“attachments”: [ “base64string1”, “base64string2” ]

REQUEST

KEY	DESCRIPTION	EXAMPLE
Wolkvox-Server	Operation server nomenclature.	‘https://wolkvox_server.crmvox.com/server/API/v2/cases/insertAttach.php’
Wolkvox-Token	Token generated in the CRM module where you will consume the API.	‘Wolkvox-Token: token’
operation	Operation name.	“operation”: “TheOperationName”
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.	“case-type”: “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.	“responsible”: “ADMIN_@mymodule”
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.	“owner”: “ADMIN_@mymodule”
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.	“contact”: “[email protected]”
description	Case description.	“description”: “This is the case description.”
form	This field is used to specify additional details of the case.	“form”:{ “Subject”: “This is an additional field created in the CRM.” }
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.	“status”: “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.	“priority”: “low”
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”.	“solution”: “This is an example of a solution to a case. “
attachments	You can add attachments in base64 here.	“attachments”: [ “base64string1”, “base64string2” ]

				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{wolkvox_server}}/server/API/v2/cases/insertAttach.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}}",
    "case-type":"{{case type}}",
    "responsible":"{{responsible}}",
    "owner":"{{owner}}",
    "contact":"{{contact}}",
    "description":"{{description}}",
    "form":{
      "Subject": "{{subject}}"
    },
    "status": "{{status}}",
    "priority":"{{priority}}",
    "attachments": [  ]
}',
  CURLOPT_HTTPHEADER => array(
    'Wolkvox-Token: {{token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location 'https://{{wolkvox_server}}/server/API/v2/cases/insertAttach.php' \
--header 'Wolkvox-Token: {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "operation":"{{operation}}",
    "case-type":"{{case-type}}",
    "responsible":"{{responsible}}",
    "owner":"{{owner}}",
    "contact":"{{contact}}",
    "description":"{{description}}",
    "form":{
      "Subject": "{{subject}}"
    },
    "status": "{{status}}",
    "priority":"{{priority}}",
    "attachments": [  ]
}'

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n    \"operation\":\"{{operation}}\",\r\n    \"case-type\":\"{{case-type}}\",\r\n    \"responsible\":\"{{responsible}}\",\r\n    \"owner\":\"{{owner}}\",\r\n    \"contact\":\"{{contact}}\",\r\n    \"description\":\"{{description}}\",\r\n    \"form\":{\r\n      \"Subject\": \"{{subject}}\"\r\n    },\r\n    \"status\": \"{{status}}\",\r\n    \"priority\":\"{{priority}}\",\r\n    \"attachments\": [  ]\r\n}");
Request request = new Request.Builder()
  .url("https://{{wolkvox_server}}/server/API/v2/cases/insertAttach.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/insertAttach.php"

payload = json.dumps({
  "operation": "{{operation}}",
  "case-type": "{{case-type}}",
  "responsible": "{{responsible}}",
  "owner": "{{owner}}",
  "contact": "{{contact}}",
  "description": "{{description}}",
  "form": {
    "{{campo-adicional}}": "{{valor-del-campo-adicional}}"
  },
  "status": "{{status}}",
  "priority": "{{priority}}",
  "attachments": []
})
headers = {
  'Wolkvox-Token': '{{token}}',
  'Content-Type': 'application/json'
}

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

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

< / >

Insert

Insert Cases with Attachments

REQUEST

RESPONSE

COLOMBIA

ARGENTINA

BRAZIL

CHILE

SPAIN

UNITED STATES

GUATEMALA

MEXICO

DOMINICAN REPUBLIC

PERU