Search
Close this search box.

< / >

APIs Reports Manager

8. Machine codes grouped by telephone and results

URL:

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

Description:

It identifies on a consolidated basis by phone number the number of times this record was dialed and specifically the number of machine code results.

Benefit:

It allows you to track the number of machine code recognitions in the operation, in addition this report allows you to verify the quality of the database by identifying those numbers that are not effective in order to eliminate them and increase the efficiency of the dialing.

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.

Request

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

Response

NAME DESCRIPTION TYPE
telephone Registry telephone number String
total_machine_recognitions Total number of machine code recognitions the number has had String
no_answer Number of recognized machine codes String
answer_machine Number of recognized machine codes String
busy Number of recognized machine codes String
congestion Number of recognized machine codes String
failed Number of recognized machine codes 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_8&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": [
        {
            "telephone": "",
            "total_machine_recognitions": "",
            "no_answer": "",
            "answer_machine": "",
            "busy": "",
            "congestion": "",
            "failed": ""
        }
    ]
} 

				
			
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