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 (no–answer, answer, failed, busy, congestion, recall, do–not–call–clean) 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 | It is the Result of the Interaction | String |
records | Indicate the Number of Calls or Dial Attempts | String |
percent | Percentage of Final Results | String |