WHY WOLKVOX? OMNICHANNEL PLATFORM WOLKVOX CRM CHATBOTS AND VOICEBOTS MANUALS

COLOMBIA Medellín +57 (4) 322 98 80 Bogotá +57 (1) 381 90 40 Cali +57 (2) 891 28 46 Barranquilla +57 (5) 316 10 34 ARGENTINA Buenos Aires +54 (11) 5217 5933 SPAIN Madrid +34 (910) 601 691 MEXICO Ciudad de México +52 (55) 8526 36 34 BRASIL Brasilia +55 (61) 9836 4127 São Paulo +55 (12) 9811 155 83 UNITED STATES New York +1 (914) 373 71 36 DOMINICAN REPUBLIC Santo Domingo +1 (829) 249 69 68 CHILE Santiago de Chile +56 (2) 240 533 89 GUATEMALA Ciudad de Guatemala +502 (2) 314 1344 PERU Lima +51 (1) 644 91 39

Insert management

< / >

Insert management

URL:

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

Description:

This API allows inserting managements into a record of a debt collection module.

¿How it works?:

This API operates through a ‘raw‘ type body and a POST request, which requires the following fields for its proper functioning:

– The request headers require:

Wolkvox-Token

– In the request body, it is required:

operation
wolkvox-id
fields

Note: Within ‘fields‘, the main field to reference the record where you want to insert the action is ‘wolkvox_idRecord’. The mandatory fields are: ‘tipification_code’, ‘tipification_desc’, ‘module’, and ‘wolkvox_idRecord’.

The remaining fields within ‘fields’ are optional and depend on your requirements for inserting the action.

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	DESCRIPCIÓN	EJEMPLO
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”
fields	JSON object containing a set of attributes describing the action to be inserted.	“fields”: {}
tipifycation_code	Classification code.
tipifycation_desc	Classification description.
module	CRM module. In this case, being an API for debt collection, it should target 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	Customer last name.
client_type_document	Customer’s identification document type.
client_telephone	Customer’s phone number.
agent_name	Name of the agent who performed the action.
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	Customer identification number in the wolkvox application.
wolkvox_phoneCall	Phone number in the wolkvox application.
wolkvox_CrmPhoneCall	Phone number in the call of the wolkvox CRM application.
obligation	Obligation reference name.

REQUEST

				
					$curl = curl_init();

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

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location 'https://{{wolkvox_server}}/server/API/v2/collections/insertGestion.php' \
--header 'Wolkvox-Token: {{Wolkvox-Token}}' \
--header 'Content-Type: application/json' \
--data '{
    "operation": "",
    "fields": {
        "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": ""
    }
}'

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n    \"operation\": \"\",\r\n    \"fields\": {\r\n        \"tipifycation_code\": \"\",\r\n        \"tipifycation_desc\": \"\",\r\n        \"module\": \"\",\r\n        \"id_customer\": \"\",\r\n        \"customer_id\": \"\",\r\n        \"wolkvox_idRecord\": \"\",\r\n        \"wolkvox_idCall\": \"\",\r\n        \"client_name\": \"\",\r\n        \"client_lastname\": \"\",\r\n        \"client_type_document\": \"\",\r\n        \"client_telephone\": \"\",\r\n        \"agent_name\": \"\",\r\n        \"agent_id\": \"\",\r\n        \"type_interaction\": \"\",\r\n        \"time\": \"\",\r\n        \"date\": \"\",\r\n        \"campaign_id\": \"\",\r\n        \"tipification_code\": \"\",\r\n        \"tipification_description\": \"\",\r\n        \"wolkvox_idCustomer\": \"\",\r\n        \"wolkvox_phoneCall\": \"\",\r\n        \"wolkvox_CrmPhoneCall\": \"\",\r\n        \"obligation\": \"\"\r\n    }\r\n}");
Request request = new Request.Builder()
  .url("https://{{wolkvox_server}}/server/API/v2/collections/insertGestion.php")
  .method("POST", body)
  .addHeader("Wolkvox-Token", "{{Wolkvox-Token}}")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

				
					import requests
import json

url = "https://{{wolkvox_server}}/server/API/v2/collections/insertGestion.php"

payload = json.dumps({
  "operation": "",
  "fields": {
    "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": ""
  }
})
headers = {
  'Wolkvox-Token': '{{Wolkvox-Token}}',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

RESPONSE

KEY	DESCRIPTION	EXAMPLE
code	Indicates the response status code.	“code”: 200
error	Provides details about the error that occurred during the request.	“error”: “null”
msg	Displays 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 making the request.	“data”: { “wolkvox_id”: “” }

				
					{
    "code": 200,
    "error": "null",
    "msg": "Succesfully create record",
    "data": {
        "wolkvox_id": "123cb"
    }
}

Possible error codes

< / >