fbpx

< / >

Cases Update

Cases Update

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:

  • Wolkvox-Token 

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

  • operation
  • wolkvox-id
  • case-type
  • responsible
  • status
  • priority
  • form
  • file

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}
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.
				
					<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '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;

				
			

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”
				
					{
    "code":200,"error":"null","msg":"Succesfully update record","data":{"wolkvox_id":""}
}
				
			
Possible error codes

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

We use cookies, if you continue browsing we will assume that you agree. You can read more about the use of cookies in our privacy policies and treatment of personal data