Search
Close this search box.

< / >

APIs Reports Manager

3. Result of telephone – telephone campaigns

URL:

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

Description:

This report allows you to track outbound campaigns (predictive) taking into account the phone-to-phone result of the database that has been previously uploaded. It relates the campaign ID, call ID, date, contact result and customer information (first name, last name, ID and phone number).

Benefit:

It allows you to assess the quality of the database on a phone-by-phone basis and even to identify those contacts that could be contacted at other times or whose information is wrong.

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.
  • 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.
  • The registration date must be within the search date range and each attempt must be within the same range.
  • The attempt date is always in GMT-5.

Request

NAME DESCRIPTION TYPE
api Type of report required String
campaign_id Number identification of the campaign String
date_ini Inicial Date (YYYYmmddHHiiss) String
date_end Final Date (YYYYmmddHHiiss) String

Response

NAME DESCRIPTION TYPE
campaign_id Corresponds to the campaign identification number String
customer_name Client’s name String
customer_last_name Customer’s last name String
id_type Type of Identification String
customer_id Corresponds to the customer’s identification number String
date Indicates the date with format year-month-day-time String
telephone Indicates the telephone number to which the call was placed String
result It is the result of the call. This column can provide the values abandon (abandoned), answer (answered), answer-machine (answered by a machine), busy (busy), congestion (congested line), failed (failed), and no-answer (unanswered). String
opt# Fields in the campaign database that allow the entry of customer contact information. String
conn_id Corresponds to the call identification number 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_3&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;

				
			

RESPONSE

				
					{
    "code": 200,
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "campaign_id": "",
            "customer_name": "",
            "customer_last_name": "",
            "customer_id": "",
            "date": "",
            "telephone": "",
            "result": "",
            "opt1": "",
            "opt2": "",
            "opt3": "",
            "opt4": "",
            "opt5": "",
            "opt6": "",
            "opt7": "",
            "opt8": "",
            "opt9": "",
            "opt10": "",
            "opt11": "",
            "opt12": "",
            "conn_id": "",
            "id_type": "",
        }
    ]
}

				
			
We use cookies, if you continue browsing we will assume that you agree. You can read more about the use of cookies in our privacy policies and treatment of personal data