fbpx

< / >

Query management

Query management

URL:

https://{{wolkvox_server}}/server/API/v2/collections/queryGestion.php

Descripción:

This API allows querying the obligation of a record in the collections module.

How it works?:

This API works through a “raw” type body and a GET request, which requires the following fields for its proper operation:

In the request headers, the following is required:

  • Wolkvox-Token

– In the request body, the following is required:

  • operation
  • obligation
  • wolkvox-id

 

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.
A8K3J7F2
operation
It is the name of the CRM operation.
“operation”:”testmodule”
field
It is the field to refer to for the search.
“field”: “customer_id”
value
It is the value to search for.
“value”: “123”

REQUEST

				
					$curl = curl_init();

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

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

KEY
DESCRIPTION
EXAMPLE
Wolkvox-Token
It is the token configured by the client on the CRM page.
A8K3J7F2
operation
It is the name of the CRM operation.
“operation”:”testmodule”
tipifycation_code
Codification code.
tipifycation_desc
Classification description.
module
CRM module. In this case, being an API for collections, it should point to the “collections” module.
“module”: “collections”
id_customer
Customer identification number.
customer_id
Additional customer identification.
wolkvox_idRecord
Identification code of the record in the collections module.
wolkvox_idCall
Call identification number.
client_name
Customer name.
client_lastname
Last name of the customer.
client_type_document
Type of customer identification document.
client_telephone
Customer’s phone number.
agent_name
Agent’s name who carried out the management.
agent_id
Agent’s extension number.
type_interaction
Type of interaction used to manage the record.
time
Interaction time.
date
Interaction date.
campaign_id
Campaign identification code.
wolkvox_idCustomer
Wolkvox application customer identification number.
wolkvox_phoneCall
Wolkvox application phone number.
wolkvox_CrmPhoneCall
Phone number in the wolkvox CRM application call.
obligation
Obligation reference name.
wolkvox_usuario_creacion
User who created the management.
wolkvox_origen
Indicates from where the management was inserted.
wolkvox_ip_address
Indicates the IP from which the request to insert the management was made.
wolkvox_owner
It is a set of data about the owner of the management. It displays the user (user), name (nombre), identification number (id), and email address (email).
wolkvox_id
Record Identification Code.
				
					{
    "code": "200",
    "error": "null",
    "msg": "1 records were are found",
    "data": [
        {
            "tipifycation_code": "",
            "tipifycation_desc": "",
            "module": "",
            "id_customer": "",
            "customer_id": "",
            "wolkvox_idRecord": "",
            "wolkvox_idCall": "",
            "client_name": "",
            "client_lastname": "",
            "client_type_document": "",
            "client_telephone": "",
            "agent_name": "",
            "agent_id": "",
            "type_interaction": "",
            "time": "",
            "date": "",
            "campaign_id": "",
            "tipification_code": "",
            "tipification_description": "",
            "wolkvox_idCustomer": "",
            "wolkvox_phoneCall": "",
            "wolkvox_CrmPhoneCall": "",
            "obligation": "",
            "wolkvox_usuario_creacion": "",
            "wolkvox_origen": "",
            "wolkvox_ip_address": "",
            "wolkvox_owner": {
                "user": "",
                "nombre": "",
                "id": "",
                "email": ""
            },
            "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