URL:
https://{{wolkvox_server}}/server/API/v2/cases/update.php
Description:
The update cases API allows us to search for records exclusively within the configured module by sending parameters.
How does it work?:
This API works through a ‘form-data‘ type body and a POST request, which requires the following fields for its proper functioning:
– The request headers required are:
– In the body of the request, the following fields are required:
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:
How to determine the CRM server?
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.
KEY | DESCRIPTION | EXAMPLE |
---|---|---|
Wolkvox-Token | It is the token configured by the client on the CRM page. | {token} |
Wolkvox-id | It is the ID of the record. | 6074xxx0801374xxxxx781025xxx7d3 |
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} |
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 solved. |
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 configured in our CRM. | {“name_field”: “value_field”} |
file | These are the attachments. |
'https://{{wolkvox_server}}/server/API/v2/cases/update.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}','wolkvox-id' => '{wolkvox-id}','responsible' => '{responsible}','status' => '{status}','solution' => '{solution}','form' => '{}','files'=> new CURLFILE('/path/to/file')),
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/update.php' \
--header 'Wolkvox-Token: {Wolkvox-Token}' \
--form 'operation="{operation}"' \
--form 'wolkvox-id="{wolkvox-id}"' \
--form 'responsible="{responsible}"' \
--form 'status="{status}"' \
--form 'solution="{solution}"' \
--form 'form="{}"' \
--form 'files=@"/path/to/file"'
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/update.php")
.method("POST", body)
.addHeader("Wolkvox-Token", "{Wolk_Token}")
.build();
Response response = client.newCall(request).execute();
import requests
url = "https://{{wolkvox_server}}/server/API/v2/cases/update.php"
payload={'operation': '{operation}',
'wolkvox-id': '{wolkvox-id}',
'responsible': '{responsible}',
'status': '{status}',
'solution': '{solution}',
'form': '{}'}
files=[
('files',('file',open('/path/to/file','rb'),'application/octet-stream'))
]
headers = {
'Wolkvox-Token': '{Wolkvox-Token}'
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.text)
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” |
{
"code":200,"error":"null","msg":"Succesfully update record","data":{"wolkvox_id":""}
}
Medellín +57 (604) 322 98 80
Bogotá +57 (601) 381 90 40
Cali +57 (602) 891 28 46
Barranquilla +57 (605) 316 10 34
Goiânia +55 (62) 99328 6605
Santiago de Chile +56 (2) 240 533 89
Atlanta +1 (678) 496 7474
Ciudad de Guatemala +502 (2) 314 1344
Ciudad de México +52 (55) 8526 36 34
Copyright © 2022 MICROSYSLABS S.A.S. Cra 30 # 4A-45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia
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
Copyright © 2022 MICROSYSLABS S.A.S.
Cra 30 # 4A – 45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia
Usamos cookies, se continuar a navegar assumimos que concorda. Pode ler mais sobre a utilização de cookies nas nossas políticas de privacidade e tratamento de dados pessoais