Search
Close this search box.

< / >

APIs Reports Manager

5. Disposition codes grouped by code

URL:

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

Description:

This report of code usage categorized by code provides users with an efficient way to access detailed information about how typification codes are used within the system. This API enables developers and administrators to obtain relevant data for analysis and optimization of typification code management in their operation.

Benefit:

This innovation significantly aids you in analyzing how the activity codes are utilized in your operation.

How does it work?

  • The consumption of this API is done through the GET method.
  • To consume this API, you must replace {{wolkvox_server}} in the URL with the nomenclature of your operation’s server.
  • The wolkvox-token header must be used to utilize the authorization token.
  • Keep in mind that the same token cannot be consumed simultaneously; therefore, you can program the next API consumption after the successful result of the previous one.
  • In terms of timing, to monitor your operation, you can make an API consumption every 5 minutes for the information.

REQUEST

NAME DESCRIPTION TYPE
api Report type required String
date_ini Start date (YYYYmmddHHiiss) String
date_end End date (YYYYmmddHHiiss) String
cod_act Activity code group (cod_act1) or (cod_act2) String

RESPONSE

NAME DESCRIPTION TYPE
count Indicates the number of times the activity code was used within the specified date range. String
cod_act This is the ID of the activity 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 activity 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

Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?date_ini={{date_ini}}&date_end={{date_end}}&api=act_5&cod_act={{cod_act}}',
  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;

				
			

RESPONSE

				
					{
    "code": 200,
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "count": "",
            "cod_act": "",
            "description_cod_act": ""
        }
    ]
}
				
			
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