fbpx
Precios
Search
Close this search box.
Precios
Search
Close this search box.
Search
Close this search box.

< / >

APIs -- seleccione una opción --

7. Real time reporting of campaigns En

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
Posibles códigos de respuesta
200, 400, 401, 403, 404, 405, 412 
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL =&gt; 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=campaigns',
  CURLOPT_RETURNTRANSFER =&gt; true,
  CURLOPT_ENCODING =&gt; '',
  CURLOPT_MAXREDIRS =&gt; 10,
  CURLOPT_TIMEOUT =&gt; 0,
  CURLOPT_FOLLOWLOCATION =&gt; true,
  CURLOPT_HTTP_VERSION =&gt; CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST =&gt; 'GET',
  CURLOPT_HTTPHEADER =&gt; array(
    'wolkvox-token: {{wolkvox_token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

RESPONSE

				
					[
        {
            "campaign": "4875 - MY CAMPAIGN - tel1 (100%)",
            "speed": "110%",
            "status": "started",
            "skill_id": "4000",
            "records": "1",
            "clean": "1",
            "dial": "0",
            "answer": "0",
            "no_answer": "0",
            "busy/congestion/failed": "0",
            "answer_machine": "0",
            "penetration_day": "0.00 %",
            "penetration_now": "0.00 %",
            "hits": "0 (0.00 %)",
            "calls_x_min": "0",
            "recycled": "0"
        } 
]

Hacemos uso de cookies, si continúas navegando asumiremos que estás de acuerdo. Puede leer más sobre el uso de cookies en nuestras políticas de privacidad y tratamiento de datos personales

aceptar y cerrar

Hacemos uso de cookies, si continúas navegando asumiremos que estás de acuerdo. Puede leer más sobre el uso de cookies en nuestras políticas de privacidad y tratamiento de datos personales

aceptar y cerrar