URL:
https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=campaign_7&campaign_id={{campaign_id}}&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}
Description:
This report allows you to track answering machine acknowledgements in detail by relating the customer ID and campaign, the phone number, the date, the AMD result and the optional voice file that can be left as a voice message on the answering machines.
Benefit:
Knowing the details of the interactions that were handled by the answering machine allows you to evaluate the effectiveness of the database by identifying those contacts that are difficult to connect.
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 |
---|---|---|
customer_id | Corresponds to the customer’s identification number | String |
campaign_id | Corresponds to the campaign identification number | String |
file_name | This is the name of the voice file configured in the AMD to give the client information when the machine answers. | String |
telephone | Indicates the telephone number to which the call was placed | String |
result | It is the result of the automatic answering machine recognition functionality. | String |
date | Indicates the date with format year-month-day-time | String |