fbpx

< / >

Query

Query

URL:

https://sv{{wolkvox_server}}.crmvox.com/server/API/v2/custom/query.php

Descripción:

El API de búsqueda nos permite mediante el envío de parámetros buscar registros en los módulos parametrizados de nuestro CRM.

Cómo funciona?:

Esta API funciona a través de una petición en POST, la cuál requiere para su correcto funcionamiento los siguientes campos: – en el header: “Wolkvox-Token“, En el cuerpo de la petición se requiere: – “operation“, “module” , “field” , “value“.

REQUEST

CAMPO
DESCRIPCIÓN
operation
Es la operación en la que el cliente tiene configurado el token y el módulo en el que se crea el registro.
wolkvox-token
Es el token configurado por el cliente en la página de CRM, el cual va ubicado en los headers.
module
Es el módulo que va a consultar el cliente.
field
Los parámetros de nuestra búsqueda, son los campos que el cliente tiene configurado en su módulo.
value
Se le da el valor de búsqueda que necesitaremos a través del campo “field”.

RESPONSE

Dirección

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" ] } ] },
				
			

Casilla de Verificación

RESPONSE

				
					"Campo": [ "aprobado" ]
				
			

Usuario Actual

RESPONSE

				
					"Usuario": "Usuarioactual@operacion"
				
			

Moneda

RESPONSE

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

Fecha

RESPONSE

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

Fecha y hora

RESPONSE

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

Descripcion

RESPONSE

				
					"Desc": "Texto"
				
			

Correo

RESPONSE

				
					"Correo": "correo@wolkvox.com"
				
			

Lista

RESPONSE

				
					"Lista": "A"
				
			

Lista de selección múltiple

RESPONSE

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

Número

RESPONSE

				
					"Numero": 8
				
			

Opción de radio

RESPONSE

				
					"Radio": "D"
				
			

Aleatorio

RESPONSE

				
					"Ramdon": "d5e1fy9f8b86a0"
				
			

Interruptor

RESPONSE

				
					"Interruptor": true
				
			

Teléfono

RESPONSE

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

Texto

RESPONSE

				
					"Texto": "texto"
				
			

Hora

RESPONSE

				
					"Hora": "08:24:47"
				
			

URL

RESPONSE

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

Búsqueda

RESPONSE

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

Moneda

RESPONSE

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

Phone

RESPONSE

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

Dirección

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;	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
				
			
Posibles códigos de error

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

Hacemos uso de cookies, si continúas navegando asumiremos que estás de acuerdo. Puede leer más sobre el uso de cookies en nuestras políticas de privacidad y tratamiento de datos personales