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.
| REQUEST |
| NAME | DESCRIPTION | TYPE |
|---|---|---|
| api | Type of report required | String |
| RESPONSE |
| NAME | DESCRIPTION | TYPE |
|---|---|---|
| campaign | Displays information on campaign id, name and dialing percentage by phone | String |
| speed | Refers to the speed of the campaign | String |
| status | Details the status of the campaign | String |
| skill_id | Indicates the number of skill linked to the campaign | String |
| records | Total number of registrations in the campaign | String |
| clean | Number of uncalled records | String |
| dial | Number of marked records | String |
| answer | Indicates the number of records answered | String |
| no_answer | Indicates the number of unanswered records | String |
| busy/congestion/failed | Refers to busy, congestion and failed registrations. | String |
| answer_machine | Results of machine records | String |
| penetration_day | Campaign day penetration | String |
| penetration_now | Penetration of the momentum at the time of campaign consumption | String |
| hits | Indicates the number of records typified as “hits”. | String |
| calls_x_min | Calls per minute in the campaign | String |
| recycled | Number of times the campaign has been recycled | String |