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_1&campaign_id={{campaign_id}}&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}

Description:

This report allows to evaluate the performance of the campaign taking into account the number of records of the final machine results (noanswer, answer, failed, busy, congestion, recall, donotcallclean) and the percentage of these in the total of the campaign.

Benefit:

It allows understanding how the contactability of customers in outbound automatic campaigns has been.

How it works:

REQUEST

NAME DESCRIPTION TYPE
api Required Report Type String
campaign_id Numeric Identification of Campaign String
date_ini Initial Date (YYYYmmddHHiiss) String
date_end Final Date (YYYYmmddHHiiss) String

RESPONSE

NAME DESCRIPTION TYPE
result Indicates the response code obtained from the machine. The machine codes are: no-answer (not answered), busy (line busy), answer (answered), answer-machine (answered by a machine), recall (recall), do-not-call_clean (numbers on do not call list), congestion (congested line), and abandon (abandoned call). String
records Indicate the Number of Calls or Dial Attempts String
percent Percentage of Final Results 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_1&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": [
        {
            "result": "",
            "records": "",
            "percent": ""
        }
    ]
}

				
			

< / >

APIs Reports Manager

1. Campaign by Machine (Final Result) En

URL:

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

Description:

This report allows to evaluate the performance of the campaign taking into account the number of records of the final machine results (noanswer, answer, failed, busy, congestion, recall, donotcallclean) and the percentage of these in the total of the campaign.

Benefit:

It allows understanding how the contactability of customers in outbound automatic campaigns has been.

How it works:

  • The consumption of this API is done through the GET method.
  • To consume this API you must replace the {ip_ipdialbox} in the URL with the server nomenclature of the operation and the {token} generated from the Wolkvox Manager to obtain the information securely.
  • Keep in mind that the same token cannot be consumed simultaneously, so you can program the next API to be consumed when the result of the previous one is successful.
  • In terms of time, to track your operation you can consume the information every 5 minutes.

NAME DESCRIPTION TYPE
api Required Report Type String
campaign_id Numeric Identification of Campaign String
date_ini Initial Date (YYYYmmddHHiiss) String
date_end Final Date (YYYYmmddHHiiss) String

NAME DESCRIPTION TYPE
result Indicates the response code obtained from the machine. The machine codes are: no-answer (not answered), busy (line busy), answer (answered), answer-machine (answered by a machine), recall (recall), do-not-call_clean (numbers on do not call list), congestion (congested line), and abandon (abandoned call). String
records Indicate the Number of Calls or Dial Attempts String
percent Percentage of Final Results 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_1&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": [
        {
            "result": "",
            "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