WHY WOLKVOX? OMNICHANNEL PLATFORM WOLKVOX CRM CHATBOTS AND VOICEBOTS MANUALS

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

1. Campaign by Machine (Final Result) En -

< / >

APIs Reports Manager

1. Campaign by Machine (Final Result) En

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=campaign_1&campaign_id={{campaign_id}}&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}

Description:

This report allows to evaluate the performance of the campaign taking into account the number of records of the final machine results (no–answer, answer, failed, busy, congestion, recall, do–not–call–clean) and the percentage of these in the total of the campaign.

Benefit:

It allows understanding how the contactability of customers in outbound automatic campaigns has been.

How it works:

The consumption of this API is done through the GET method.
To consume this API you must replace the {ip_ipdialbox} in the URL with the server nomenclature of the operation and the {token} generated from the Wolkvox Manager to obtain the information securely.
Keep in mind that the same token cannot be consumed simultaneously, so you can program the next API to be consumed when the result of the previous one is successful.
In terms of time, to track your operation you can consume the information every 5 minutes.
Limit of records that can be downloaded per consumption: 60,000 records.
Limit of records that can be uploaded per consumption: 10,000 records.
Limit of days queried in dates: 31 days.
Limit of result weight: 256 MB.
API consumption time limit: 60 seconds.
Concurrent consumption limit of a token: 2 simultaneous requests.
Daily limit of tokens: Number of licenses multiplied by 1000 daily tokens.

Request

NAME	DESCRIPTION	TYPE
api	Required Report Type	String
campaign_id	Numeric Identification of Campaign	String
date_ini	Initial Date (YYYYmmddHHiiss)	String
date_end	Final Date (YYYYmmddHHiiss)	String

Response

NAME	DESCRIPTION	TYPE
result	Indicates the response code obtained from the machine. The machine codes are: no-answer (not answered), busy (line busy), answer (answered), answer-machine (answered by a machine), recall (recall), do-not-call_clean (numbers on do not call list), congestion (congested line), and abandon (abandoned call).	String
records	Indicate the Number of Calls or Dial Attempts	String
percent	Percentage of Final Results	String

Possible response codes

				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=campaign_1&campaign_id={{campaign_id}}&date_ini={{date_ini}}&date_end={{date_end}}',
  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_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location --globoff 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=campaign_1&campaign_id={{campaign_id}}&date_ini={{date_ini}}&date_end={{date_end}}' \
--header 'wolkvox_server: {{wolkvox_server}}' \
--header 'wolkvox-token: {{wolkvox-token}}'

				
					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/reports_manager.php?api=campaign_1&campaign_id={{campaign_id}}&date_ini={{date_ini}}&date_end={{date_end}}")
  .method("GET", body)
  .addHeader("wolkvox_server", "{{wolkvox_server}}")
  .addHeader("wolkvox-token", "{{wolkvox-token}}")
  .build();
Response response = client.newCall(request).execute();

				
					import requests

url = "https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=campaign_1&campaign_id={{campaign_id}}&date_ini={{date_ini}}&date_end={{date_end}}"

payload = {}
headers = {
  'wolkvox_server': '{{wolkvox_server}}',
  'wolkvox-token': '{{wolkvox-token}}'
}

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

print(response.text)

RESPONSE

				
					{
    "code": 200,
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "result": "",
            "records": "",
            "percent": ""
        }
    ]
}

APPLICATIONS

MULTICHANNEL DIALER

WOLKVOX STUDIO

ARTIFICIAL INTELLIGENCE

VOICE OF THE CUSTOMER

QUALITY AND PRODUCTIVITY

ANALYTICS

TELEPHONY

INTEGRATIONS

BY INDUSTRY

BY COMPANY TYPE

SMART TEAMS

AUTOMATION AND ARTIFICIAL INTELLIGENCE

DIGITAL TRANSFORMATION

APPLICATIONS

MULTICHANNEL DIALER

WOLKVOX STUDIO

ARTIFICIAL INTELLIGENCE

VOICE OF THE CUSTOMER

QUALITY AND PRODUCTIVITY

ANALYTICS

TELEPHONY

INTEGRATIONS

BY INDUSTRY

BY COMPANY TYPE

SMART TEAMS

AUTOMATION AND ARTIFICIAL INTELLIGENCE

DIGITAL TRANSFORMATION

< / >

APIs Reports Manager

1. Campaign by Machine (Final Result) En

Request

Response

RESPONSE

UNITED STATES

ARGENTINA

BRAZIL

CHILE

SPAIN

COLOMBIA

GUATEMALA

MEXICO

DOMINICAN REPUBLIC

PERU

AUTOMATION AND
ARTIFICIAL INTELLIGENCE

AUTOMATION AND
ARTIFICIAL INTELLIGENCE