fbpx
Search
Close this search box.
Search
Close this search box.

URL:

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

Description:

This report allows you to evaluate the performance of the campaign by taking into account the number of activity code records and their percentage of the total campaign.

Benefit:

Allows to understand the customer contactability of automatic outbound campaigns.

How it works:

REQUEST

NAME DESCRIPTION TYPE
api Type of report required String
campaign_id Number identification of the campaign String
date_ini Initial Date (YYYYmmddHHiiss) String
date_end Final Date (YYYYmmddHHiiss) String

RESPONSE

NAME DESCRIPTION TYPE
cod_act Indicates the activity or categorization codes used by agents to classify the records. It may receive the value “TIMEOUTACW,” which indicates the event where the agent did not manage to categorize the interaction. This is available in cases where the agent time limit configuration for categorizing interactions is active. String
records Indicates the number of calls or dialing attempts String
percent Percentage of activity code records 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=campaign_2&campaign_id={{campaign_id}}&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}',
  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-token: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": 200,
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "cod_act": "",
            "records": "",
            "percent": ""
        }
    ]
}

				
			

URL:

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

Description:

This report allows you to evaluate the performance of the campaign by taking into account the number of activity code records and their percentage of the total campaign.

Benefit:

Allows to understand the customer contactability of automatic outbound campaigns.

How it works:

NAME DESCRIPTION TYPE
api Type of report required String
campaign_id Number identification of the campaign String
date_ini Initial Date (YYYYmmddHHiiss) String
date_end Final Date (YYYYmmddHHiiss) String

NAME DESCRIPTION TYPE
cod_act Indicates the activity or categorization codes used by agents to classify the records. It may receive the value “TIMEOUTACW,” which indicates the event where the agent did not manage to categorize the interaction. This is available in cases where the agent time limit configuration for categorizing interactions is active. String
records Indicates the number of calls or dialing attempts String
percent Percentage of activity code records 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=campaign_2&campaign_id={{campaign_id}}&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}',
  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-token: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": 200,
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "cod_act": "",
            "records": "",
            "percent": ""
        }
    ]
}

				
			

URL:

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

Description:

This report allows you to evaluate the performance of the campaign by taking into account the number of activity code records and their percentage of the total campaign.

Benefit:

Allows to understand the customer contactability of automatic outbound campaigns.

How it works:

NAME DESCRIPTION TYPE
api Type of report required String
campaign_id Number identification of the campaign String
date_ini Initial Date (YYYYmmddHHiiss) String
date_end Final Date (YYYYmmddHHiiss) String

NAME DESCRIPTION TYPE
cod_act Indicates the activity or categorization codes used by agents to classify the records. It may receive the value “TIMEOUTACW,” which indicates the event where the agent did not manage to categorize the interaction. This is available in cases where the agent time limit configuration for categorizing interactions is active. String
records Indicates the number of calls or dialing attempts String
percent Percentage of activity code records 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=campaign_2&campaign_id={{campaign_id}}&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}',
  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-token: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": 200,
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "cod_act": "",
            "records": "",
            "percent": ""
        }
    ]
}

				
			

< / >

APIs Customer

2. Results by type of code

URL:

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

Description:

This report allows you to evaluate the performance of the campaign by taking into account the number of activity code records and their percentage of the total campaign.

Benefit:

Allows to understand the customer contactability of automatic outbound campaigns.

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.

NAME DESCRIPTION TYPE
api Type of report required String
campaign_id Number identification of the campaign String
date_ini Initial Date (YYYYmmddHHiiss) String
date_end Final Date (YYYYmmddHHiiss) String

NAME DESCRIPTION TYPE
cod_act Indicates the activity or categorization codes used by agents to classify the records. It may receive the value “TIMEOUTACW,” which indicates the event where the agent did not manage to categorize the interaction. This is available in cases where the agent time limit configuration for categorizing interactions is active. String
records Indicates the number of calls or dialing attempts String
percent Percentage of activity code records 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=campaign_2&campaign_id={{campaign_id}}&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}',
  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-token: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": 200,
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "cod_act": "",
            "records": "",
            "percent": ""
        }
    ]
}

				
			
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