3. Type code detail - Wolkvox

< / >

APIs Billing

3. Type code detail

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=act_3&cod_act={{cod_act}}&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}

Description:

This report indicates in detail the interaction data taking into account the type codes (parameterizable for each operation), the skill, the agent information (name, Agent ID and ID), the individual call data (date, type of call, telephone, destination, duration), as well as the Customer ID and Campaign ID.

Benefit:

It allows you to track the interaction by providing typification, call and agent data, and by including Campaign ID and Customer ID, it allows you to cross-reference information from other reports for a broader view.

How it works:

The consumption of this API is done by GET method.
To consume this API you must replace in the url {{{wolkvox_server}} by the nomenclature of the server of the operation.
The wolkvox-token header must be used to make use of the authorization token.
Note that the same token cannot be consumed simultaneously, so you can schedule the next API to be consumed when the result of the previous one is successful.
In terms of time, to keep track of your operation you can make a consumption every 5 minutes of the information.
Limit of records that can be downloaded per consumption: 60,000 records.
Limit of records that can be uploaded per consumption: 10,000 records.
Limit of days queried in dates: 31 days.
Limit of result weight: 256 MB.
API consumption time limit: 60 seconds.
Concurrent consumption limit of a token: 2 simultaneous requests.
Daily limit of tokens: Number of licenses multiplied by 1000 daily tokens.

Request

NAME	DESCRIPTION	TYPE
api	Type of report required	String
date_ini	Initial Date (YYYYmmddHHiiss)	String
date_end	Final Date (YYYYmmddHHiiss)	String

Response

NAME	DESCRIPTION	TYPE
conn_id	Corresponds to the call identification number	String
agent_id	Refers to the numerical identification of the agent	String
agent_name	Agent’s name	String
agent_dni	Agent identification number	String
skill_id	Corresponds to the identification number of the skill	String
date	Indicates the date with format year-month-day-time	String
cod_act	Is the ID of the typing or coding code used by the agent. This field can display the value “TIMEOUTACW” if the agent exceeded the time limit to code the call. This functionality can be activated through the wolkvox Manager application and allows setting a time limit for the agent to categorize or code the interaction with the client.	String
description_cod_act	Indicates the description of the typing code. This field can display the value “TIMEOUTACW” if the agent exceeded the time limit to code the call. This functionality can be activated through the wolkvox Manager application and allows setting a time limit for the agent to categorize or code the interaction with the client.	String
cod_act_2	Is the ID of the typing or coding code used by the agent. This field can display the value “TIMEOUTACW” if the agent exceeded the time limit to code the call. This functionality can be activated through the wolkvox Manager application and allows setting a time limit for the agent to categorize or code the interaction with the client.	String
description_cod_act_2	Indicates the description of the typing code. This field can display the value “TIMEOUTACW” if the agent exceeded the time limit to code the call. This functionality can be activated through the wolkvox Manager application and allows setting a time limit for the agent to categorize or code the interaction with the client.	String
comments	This field contains additional information from the call documentation.	String
type_interaction	It’s the type of call, and its values could be: conference (conference call), inbound (incoming call), internal call (internal call), internal call_inb (internal incoming call), internal call_que (internal call from a queue), out_pre (outgoing call in predictive campaign), outbound_ma (manual outgoing call), and transfer (transfer call).	String
telephone	Indicates the telephone number to which the call was placed	String
destiny	Indicates the destination of the call	String
time	Indicates total elapsed time	String
hang_up	Indicates who ended the interaction	String
customer_id	Corresponds to the customer’s identification number	String
campaign_id	Corresponds to the campaign identification number	String

Possible response codes

				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=act_3&cod_act={{cod_act}}&date_ini={{date_ini}}&date_end={{date_end}}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'wolkvox_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location --globoff 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=act_3&cod_act={{cod_act}}&date_ini={{date_ini}}&date_end={{date_end}}' \
--header 'wolkvox_server: {{wolkvox_server}}' \
--header 'wolkvox-token: {{wolkvox-token}}'

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=act_3&cod_act={{cod_act}}&date_ini={{date_ini}}&date_end={{date_end}}")
  .method("GET", body)
  .addHeader("wolkvox_server", "{{wolkvox_server}}")
  .addHeader("wolkvox-token", "{{wolkvox-token}}")
  .build();
Response response = client.newCall(request).execute();

				
					import requests

url = "https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=act_3&cod_act={{cod_act}}&date_ini={{date_ini}}&date_end={{date_end}}"

payload = {}
headers = {
  'wolkvox_server': '{{wolkvox_server}}',
  'wolkvox-token': '{{wolkvox-token}}'
}

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

print(response.text)

RESPONSE

				
					{
    "code": 200,
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "conn_id": "",
            "agent_id": "",
            "agent_name": "",
            "agent_dni": "",
            "skill_id": "",
            "date": "",
            "cod_act": "",
            "description_cod_act": "",
            "cod_act_2": "",
            "description_cod_act_2": "",
            "comments": "",
            "type_interaction": "",
            "telephone": "",
            "destiny": "",
            "time": "",
            "hang_up": "",
            "customer_id": "",
            "campaign_id": ""
        }
    ]
}

wolkvox
worldwide

UNITED STATES

Atlanta, GA +1 (470) 447-2610
Miami, FL +1 (470) 447-2610

ARGENTINA

Buenos Aires +54 (11) 5217 5933

BRAZIL

Sao Paulo +55 (11) 521 75 933

CHILE

Santiago de Chile +56 (2) 240 533 89

SPAIN

Madrid +34 (910) 601 691

COLOMBIA

Medellín +57 (604) 322 98 80

GUATEMALA

Ciudad de Guatemala +502 (2) 3141344

MEXICO

Ciudad de México +52 (55) 8526 36 34

DOMINICAN REPUBLIC

Santo Domingo +1 (829) 249 69 68

PERU

Lima +51 (1) 644 91 39

|

Information security policy

|

|

Information Transfer Policies

Copyright © 2023 MICROSYSLABS. 1820 N Corporate Lakes Blvd, unit 205. Weston, FL 33326

Nosotros

OMNICHANNEL PLATFORM

CHATBOTS AND VOICEBOTS

wolkvox worldwide

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

Information security policy

Information Transfer Policies

Copyright © 2023 MICROSYSLABS S.A.S.
Cra 30 # 4A – 45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia