fbpx

< / >

Query Cases

Query Cases

URL:

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

Description:

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

How it works?:

This API works through a POST request, which requires the following fields for its proper functioning:

In the request headers, the following is required:

  • Wolkvox-Token 

 

– In the request body, the following is required:

  • operation
  • field
  • value

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}
field
It is the CRM field we will use for filtering.
status
value
It is the search criteria.
open

RESPONSE

				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{wolkvox_server}}/server/API/v2/cases/queryCases.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}}"
}
',
  CURLOPT_HTTPHEADER => array(
    'Wolkvox-Token: {{token}}',
    'Content-Type: application/json',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			
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