Search
Close this search box.

< / >

APIs Reports Manager

10. Turbo Dial grouped by machine code

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

Description:

With this API, you will be able to obtain the report of each machine code detected by the Turbo Dial service in the campaigns.

Benefit:

It accurately analyzes the efficiency and performance of Turbo Dial.

How it works:

  • This API is consumed using the GET method.
  • To use this API, replace {{wolkvox_server}} in the URL with the server nomenclature of the operation.
  • You must use the wolkvox-token header for authorization.
  • Please note that the same token cannot be consumed simultaneously, so you can schedule the next API call after the successful completion of the previous one.
  • For operational tracking purposes, 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

NAMEDESCRIPTIONTYPE
apiType of report required.String
campaign_idNumeric identification of the campaign. It can receive the value “all” to obtain the report of all campaigns of the operation.String
date_iniStart date (YYYYmmddHHiiss).String
date_endDate end (YYYYmmddHHiiss).String

Response

NAMEDESCRIPTIONTYPE
machinecodeMachine code. It can yield the following values: answer machine, no answer, failed, answer, congestion, abandon, busy, and chanunavail (channel unavailable for the outgoing call).String
cantidadNumber of times the referenced machine code was detected.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_10&campaign_id=all&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-token: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "x records were found",
    "data": [
        {
            "machinecode": "",
            "cantidad": ""
        }
    ]
}
				
			
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