URL:
https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=campaign_4&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 attempted results per machine attempt (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 you to understand how customers have been contacted in the 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.
| 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 |
|---|---|---|
| result | It is the result of the interaction | String |
| records | Indicates number of calls or dialing attempts | String |
| percent | Indicates the percentage of total calls that correspond to a machine code or result. | String |