fbpx

< / >

APIs

7. Real time reporting of campaigns

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=campaigns

Description:

This report provides a complete real-time view of campaign management, providing information on contactability, status, penetration and other functional information for campaign management.

Benefit:

This report allows you to measure the quality of your campaigns according to standardized metrics.

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.

NAMEDESCRIPTIONTYPE
apiType of report requiredString

NAMEDESCRIPTIONTYPE
campaignDisplays information on campaign id, name and dialing percentage by phoneString
speedRefers to the speed of the campaignString
statusDetails the status of the campaignString
skill_idIndicates the number of skill linked to the campaignString
recordsTotal number of registrations in the campaignString
cleanNumber of uncalled recordsString
dialNumber of marked recordsString
answerIndicates the number of records answeredString
no_answerIndicates the number of unanswered recordsString
busy/congestion/failedRefers to busy, congestion and failed registrations.String
answer_machineResults of machine recordsString
penetration_dayCampaign day penetrationString
penetration_nowPenetration of the momentum at the time of campaign consumptionString
hitsIndicates the number of records typified as “hits”.String
calls_x_minCalls per minute in the campaignString
recycledNumber of times the campaign has been recycledString

Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=campaigns',
  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: {{wolkvox_token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					[
        {
            "campaign": "4875 - MY CAMPAIGN - tel1 (100%)",
            "speed": "110%",
            "status": "started",
            "skill_id": "4000",
            "records": "1",
            "clean": "1",
            "dial": "0",
            "answer": "0",
            "no_answer": "0",
            "busy/congestion/failed": "0",
            "answer_machine": "0",
            "penetration_day": "0.00 %",
            "penetration_now": "0.00 %",
            "hits": "0 (0.00 %)",
            "calls_x_min": "0",
            "recycled": "0"
        } 
]
				
			
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