ARGENTINA
Buenos Aires +54 (11) 5217 5933
BRAZIL
Goiânia +55 (62) 99328 6605
CHILE
Santiago de Chile +56 (2) 240 533 89
Menu
Menu
Menu
URL:
https://{{wolkvox_server}}//server/API/v2/cases/listHistoryNote.php
Description:
The API allows listing the history of notes for cases associated with a company.
How does it work?
This API operates through a “raw” body type and a POST request, which requires the following fields for proper functioning:
– In the request headers, the following is required:
– In the request body, the following is required:
Considerations:
KEY | DESCRIPTION | EXAMPLE |
|---|---|---|
Wolkvox-Token | It is the token configured by the client on the CRM page. This must be of type ‘external’ and associated with the company related to the cases for which you want to query the notes. | A8K3J7F2 |
operation | It is the name of the CRM operation. | “operation”: “testmodule” |
field | It is the field from the cases module that you want to use to find the notes. You can use ‘type case’ to search by case type. | “field”: “type case” |
value | It is the search criterion according to the indicated field. If you have used ‘type case’ in the previous field, you can use ‘Request’ for requests, ‘Complaints’ for complaints, ‘Claims’ for claims, and ‘Suggestions’ for suggestions. | “value”: “Request” |
limit | Sets a limit on the number of records to search. | “limit”: “2” |
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://{{wolkvox_server}}//server/API/v2/cases/listHistoryNote.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}}",
"limit": {{limit}}
}',
CURLOPT_HTTPHEADER => array(
'Wolkvox-Token: {{wolkvox_token}}',
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
The 'data' field of the response delivers all the fields of the module plus the default fields, which are as follows:
KEY | DESCRIPTION | EXAMPLE |
|---|---|---|
idCase | Case identification number. | “idCase”: “1234” |
priority | It indicates the priority set for the case. In “value”, the number of minutes set for the priority type is indicated, and “name” is the name of the priority. | “priority”: {
“value”: 30,
“name”: “Medium”
} |
status | It indicates the current status of the case. In “value”, it indicates whether the status type is open or closed. And “name” indicates the name of the status. | “status”: {
“value”: “open”,
“name”: “In progress”
} |
description_case | It indicates the description of the case. As it is HTML compatible, this field also includes the entire HTML structure of the description. | “description_case”: “This is the description of the case” |
closeDate | It indicates the completion date of the case. The date will only appear if the case is closed. | “closeDate”: “” |
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 | It is the email address of the contact record. | “contactEmail”: “[email protected]” |
contactTel | It is the phone number of the contact record. | “contactTel”: 0000000000 |
contactIdentification | It is the identification document number of the contact record. | “contactIdentification”: “” |
namecompany | It is the company related to the case. | “namecompany”: “” |
owner | It indicates the id (identification number), level (user level), name (name), mail (email), and tel (phone) of the case owner. | “owner”: {
“id”: “”,
“level”: “”,
“name”: “”,
“mail”: “”,
“tel”: “”
} |
prefix | It indicates the prefix of the case. | “prefix”: “PET” |
responsible | It indicates the id (identification number), name (name), mail (email), tel (phone number), and group (group to which they belong. Returns ‘false’ if not part of one) of the case responsible. | “responsible”: {
“id”: “”,
“name”: “”,
“mail”: “”,
“tel”: “”,
“group”:
} |
groupsowner | It indicates the owner groups of the case. | “groupsOwner”: [] |
idPrefijo | It indicates the prefix plus the case number. | “idPrefijo”: “PET-2132xxcd” |
timeEstimated | It indicates the estimated date and time to close the case. | “timeEstimated”: “2023-08-08 14:00:07” |
reOpened | It indicates whether the case was reopened (true) or not (false). | “reOpened”: false |
form | Here are listed the additional fields to the default fields that come in a cases module. | “form”: {
“Additional Field 1”: “”
} |
history | Here is listed the history of actions performed on the record. It may include the date (date), action type (type), the user who performed the action (user), the system message about the action performed (message), and the element on which the action was performed (status). | “history”: [
{
“date”: “2023/8/8 15:59:5”,
“type”: “note”,
“user”: “Admin – Admin – user@testmodule”,
“message”: “Added the note: This is a note 2.0”,
},
{
“date”: “2023/9/29 14:25:29”,
“level”: “”,
“tag”: “status”,
“user”: “Admin – Admin – user@testmodule”,
“message”: “Changed the state from undefined to In progress.”
}
] |
wolkvox_fecha_creacion | The date and creation of the case. | “wolkvox_fecha_creacion”: “2023-08-08 13:30:07” |
wolkvox_usuario_creacion | It indicates 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@testmodule” |
wolkvox_fecha_modificacion | It indicates the date and time of the last modification of the case. | “wolkvox_fecha_modificacion”: “2023-09-29 14:25:28” |
wolkvox_usuario_modificacion | It indicates the date and time of the last modification of the case. | “wolkvox_usuario_modificacion”: “user@moduletest” |
case_dependent | It indicates if the case is dependent or independent. | “case_dependent”: “independent” |
wolkvox_origen | It indicates the origin of the case creation. | “wolkvox_origen”: “PostmanRuntime/7.32.3” |
wolkvox_ip_address | It indicates the IP address associated with the case creation. | “wolkvox_ip_address”: “1bb.ccc.ddd.ff” |
files | Lists the attachments to the case. It includes the file name (name) and the URL. | “files”: [
{
“name”: “file.jpg”,
“url”: “https://crm.wolkvox.com/…”
}
] |
nameContact | Name of the contact associated with the case. | “nameContact”: “” |
caseExpired | It indicates if the case has expired (true) or not (false). | “caseExpired”: true |
wolkvox_id | It is the unique identification of the case record. | “wolkvox_id”: “64d2dcsvb” |
{
"code": "200",
"error": "null",
"msg": "X records were are found",
"data": [
{
"idCase": "",
"caseType": "",
"priority": {
"value": ,
"name": ""
},
"status": {
"value": "",
"name": ""
},
"description_case": "",
"closeDate": "",
"contactId": "",
"contact": "",
"contactEmail": "",
"contactTel": {
"value": "",
"country": "",
"code": ""
},
"contactIdentification": "",
"namecompany": "",
"owner": {
"id": "",
"level": null,
"name": "",
"mail": "",
"tel": ""
},
"prefix": "",
"responsible": {
"id": "",
"name": "",
"mail": "",
"tel": "",
"group":
},
"groupsOwner": [],
"idPrefijo": "",
"timeEstimated": "",
"reOpened": ,
"form": {
"valor": "",
"Nombre": "",
"canal": "",
"asunto": ""
},
"history": [
{
"date": "",
"type": "note",
"user": "",
"message": ""
},
{
"date": "",
"type": "note",
"user": "",
"message": ""
},
{
"date": "",
"type": "note",
"user": "",
"message": ""
},
{
"date": "",
"message": "",
"user": ""
},
{
"color": "",
"date": "",
"level": "",
"tag": "",
"user": "",
"message": ""
},
{
"color": "",
"date": "",
"level": "",
"tag": "",
"user": "",
"message": ""
},
{
"date": "",
"type": "note",
"user": "",
"message": ""
},
{
"date": "",
"type": "note",
"user": "",
"message": ""
},
{
"date": "",
"type": "note",
"user": "",
"message": ""
}
],
"wolkvox_fecha_creacion": "",
"wolkvox_usuario_creacion": "",
"wolkvox_fecha_modificacion": "",
"wolkvox_usuario_modificacion": "",
"case_dependent": "",
"case_dependentOf": null,
"wolkvox_origen": null,
"wolkvox_ip_address": "",
"files": [],
"caseExpired": true,
"companyId": "",
"companyName": "",
"wolkvox_id": ""
},
{
"idCase": "",
"caseType": "",
"priority": {
"value": ,
"name": ""
},
"status": {
"value": "",
"name": ""
},
"description_case": "",
"closeDate": "",
"contactId": "",
"contact": "",
"contactEmail": "",
"contactTel": {
"value": "",
"country": "",
"code": ""
},
"contactIdentification": "",
"namecompany": "",
"owner": {
"id": "",
"level": null,
"name": "",
"mail": "",
"tel": ""
},
"prefix": "",
"responsible": {
"id": "",
"name": "",
"mail": "",
"group":
},
"groupsOwner": [],
"idPrefijo": "",
"timeEstimated": "",
"reOpened": ,
"form": {
"valor": "",
"Nombre": "",
"canal": "",
"asunto": ""
},
"history": [
{
"date": "",
"type": "note",
"user": "",
"message": ""
},
{
"date": "",
"type": "note",
"user": "",
"message": ""
},
{
"date": "",
"level": "",
"message": "",
"user": ""
},
{
"date": "",
"message": "",
"user": ""
},
{
"date": "",
"type": "note",
"user": "",
"message": ""
},
{
"date": "",
"type": "note",
"user": "",
"message": ""
},
{
"color": "",
"date": "",
"level": "",
"tag": "",
"user": "",
"message": ""
},
{
"color": "",
"date": "",
"level": "",
"tag": "",
"user": "",
"message": ""
}
],
"wolkvox_fecha_creacion": "",
"wolkvox_usuario_creacion": "",
"wolkvox_fecha_modificacion": "",
"wolkvox_usuario_modificacion": "",
"case_dependent": "",
"case_dependentOf": null,
"wolkvox_origen": null,
"wolkvox_ip_address": "",
"files": [],
"caseExpired": true,
"companyId": "",
"companyName": "",
"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
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