URL:
https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=campaign_3&campaign_id={{campaign_id}}&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}
Description:
This report allows you to track outbound campaigns (predictive) taking into account the phone-to-phone result of the database that has been previously uploaded. It relates the campaign ID, call ID, date, contact result and customer information (first name, last name, ID and phone number).
Benefit:
It allows you to assess the quality of the database on a phone-by-phone basis and even to identify those contacts that could be contacted at other times or whose information is wrong.
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 | Inicial Date (YYYYmmddHHiiss) | String |
| date_end | Final Date (YYYYmmddHHiiss) | String |
| RESPONSE |
| NAME | DESCRIPTION | TYPE |
|---|---|---|
| campaign_id | Corresponds to the campaign identification number | String |
| customer_name | Client’s name | String |
| customer_last_name | Customer’s last name | String |
| id_type | Type of Identification | String |
| customer_id | Corresponds to the customer’s identification number | String |
| date | Indicates the date with format year-month-day-time | String |
| telephone | Indicates the telephone number to which the call was placed | String |
| result | It is the result of the interaction | String |
| opt# | Fields in the campaign database that allow the entry of customer contact information. | String |
| conn_id | Corresponds to the call identification number | String |