fbpx

< / >

Query En

Query

URL:

https://wv{{wolkvox_server}}.wolkvox.com/server/API/v2/custom/query.php

Descripción:

The search API allows us to search for records in the parameterized modules of our CRM by sending parameters.


How does it work?:

This API works through a POST request, which requires the following fields for its correct operation: – en el header: “Wolkvox-Token“, The body of the request requires: – “operation“, “module” , “field” , “value“.

REQUEST

FIELD
DESCRIPTION
operation
It is the operation in which the client has configured the token and the module in which the record is created.
wolkvox-token
It is the token configured by the client on the CRM page, which is located in the headers.
module
It is the module that the client will consult.
field
The parameters of our search are the fields that the client has configured in his module.
value
It is given the lookup value we will need via the “field” field.

RESPONSE

Direction

RESPONSE

				
					"Direccion": { "value": "Calle 01 Casa", "addressOptions": [ { "listOptions": [ "Calle", "Carrera", "Avenida", "Circunvalar" ], "name": "Nomenclatura", "value": "Calle", "type": "list" }, { "type": "text", "name": "Numero", "value": "01", "listOptions": [] }, { "type": "list", "name": "Adicional", "value": "Casa", "listOptions": [ "Int", "Casa", "Edificio", "Apto" ] } ] },
				
			

Checkbox

RESPONSE

				
					"Campo": [ "aprobado" ]
				
			

Current user

RESPONSE

				
					"Usuario": "Usuarioactual@operacion"
				
			

Currency

RESPONSE

				
					"Moneda": { "value": "1000", "symbol": "USD", "convert": 1000 }
				
			

Date

RESPONSE

				
					"Fecha": "2022-01-03 00:00:00"
				
			

Date and Time

RESPONSE

				
					"F y H": "2022-01-21 00:04:00"
				
			

Description

RESPONSE

				
					"Desc": "Texto"
				
			

Mail

RESPONSE

				
					"Correo": "correo@wolkvox.com"
				
			

List

RESPONSE

				
					"Lista": "A"
				
			

Multiple Choice List

RESPONSE

				
					"Lista Múltiple": [ "c", "d", "a" ]
				
			

Number

RESPONSE

				
					"Numero": 8
				
			

Radio option

RESPONSE

				
					"Radio": "D"
				
			

Random

RESPONSE

				
					"Ramdon": "d5e1fy9f8b86a0"
				
			

Switch

RESPONSE

				
					"Interruptor": true
				
			

Telephone

RESPONSE

				
					"Telefono": { "value": "3014202157", "country": "Colombia", "code": "57" },
				
			

Text

RESPONSE

				
					"Texto": "texto"
				
			

Time

RESPONSE

				
					"Hora": "08:24:47"
				
			

URL

RESPONSE

				
					"url": "https://mail.google.com/mail/u/0/#chat/space/AAAAxL46GKs"
				
			

Search

RESPONSE

				
					"Busqueda": { "value": "valor1", "value_id": "6158ze11f25673d6744851zby4", "searchModuleName": "pruebaCargue" }
				
			

Currency

RESPONSE

				
					"Moneda": { "type": "currency", "value": "25", "symbol": "", "convert": 25 }
				
			

Phone

RESPONSE

				
					"Phone": { "type": "telephone", "value": "376730003", "country": "Andorra", "code": "376" }
				
			

Direction

RESPONSE

				
					
"Direccion": { "type": "address", "value": "cr 84 #65-21" }
				
			

Tabl

RESPONSE

				
					"tabl": { "type": "table", "value":[{ "op1": "valor1 ", "op2": "valor2" }, { "op1": "valor1", "op2": "valor2" }] }
				
			
				
					<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{wolkvox_server}}/server/API/v2/custom/query.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_SSL_VERIFYPEER => false,
  CURLOPT_POSTFIELDS =>'{
    "operation":"{operacion}",
    "module":"{modulo}",
    "field":"{campo}",
    "value":"{valor}"
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Wolkvox-Token: {Wolkvox_Token}'
  ),
));

$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