7. Real time reporting of campaigns - Wolkvox

< / >

APIs

7. Real time reporting of campaigns

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 campaign’s status. It can show “started” when it’s running or “stopped” when it’s halted.	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 the number of records in “busy”, “congestion”, and “failed”.	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

Possible response codes

				
					$curl = curl_init();

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

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=campaigns")
  .method("GET", body)
  .addHeader("wolkvox-token", "{{wolkvox_token}}")
  .build();
Response response = client.newCall(request).execute();

				
					import requests

url = "https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=campaigns"

payload={}
headers = {
  'wolkvox-token': '{{wolkvox_token}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

RESPONSE

				
					[
        {
            "campaign": "",
            "speed": "",
            "status": "",
            "skill_id": "",
            "records": "",
            "clean": "",
            "dial": "",
            "answer": "",
            "no_answer": "",
            "busy/congestion/failed": "",
            "answer_machine": "",
            "penetration_day": "",
            "penetration_now": "",
            "hits": "",
            "calls_x_min": "",
            "recycled": ""
        } 
]

wolkvox
worldwide

UNITED STATES

Atlanta, GA +1 (470) 447-2610
Miami, FL +1 (470) 447-2610

ARGENTINA

Buenos Aires +54 (11) 5217 5933

BRAZIL

Sao Paulo +55 (11) 521 75 933

CHILE

Santiago de Chile +56 (2) 240 533 89

SPAIN

Madrid +34 (910) 601 691

COLOMBIA

Medellín +57 (604) 322 98 80

GUATEMALA

Ciudad de Guatemala +502 (2) 3141344

MEXICO

Ciudad de México +52 (55) 8526 36 34

DOMINICAN REPUBLIC

Santo Domingo +1 (829) 249 69 68

PERU

Lima +51 (1) 644 91 39

|

Information security policy

|

|

Information Transfer Policies

Copyright © 2023 MICROSYSLABS. 1820 N Corporate Lakes Blvd, unit 205. Weston, FL 33326

OMNICHANNEL PLATFORM

CHATBOTS AND VOICEBOTS

wolkvox worldwide

COLOMBIA
Medellín +57 (4) 322 98 80
Bogotá +57 (1) 381 90 40
Cali +57 (2) 891 28 46
Barranquilla +57 (5) 316 10 34

ARGENTINA
Buenos Aires +54 (11) 5217 5933

SPAIN
Madrid +34 (910) 601 691

MEXICO
Ciudad de México +52 (55) 8526 36 34

BRASIL
Brasilia +55 (61) 9836 4127
São Paulo +55 (12) 9811 155 83

UNITED STATES
New York +1 (914) 373 71 36

DOMINICAN REPUBLIC
Santo Domingo +1 (829) 249 69 68

CHILE
Santiago de Chile +56 (2) 240 533 89

GUATEMALA
Ciudad de Guatemala +502 (2) 314 1344

PERU
Lima +51 (1) 644 91 39

Information security policy

Information Transfer Policies

Copyright © 2023 MICROSYSLABS S.A.S.
Cra 30 # 4A – 45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia