Search
Close this search box.

< / >

APIs Real Time

2. Calls in the last 10 minutes

URL:

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

Description:

This report allows you to query all calls received or made in the operation in the last 10 minutes, providing information on the call type, outcome, date, and customer ID.

Benefit:

“Monitor the calls in the last 10 minutes in your operation to get detailed insights into how it’s progressing, considering the call type (inbound – outbound) and the customer ID.”

How it works:

  • The consumption of this API is done via a GET method.
  • To use this API, replace {{wolkvox_server}} in the URL with the server nomenclature of the operation.
  • You should use the ‘wolkvox-token’ header to apply the authorization token.
  • Please note that the same token cannot be consumed simultaneously. Therefore, you can schedule the next API consumption after the previous one is successful.
  • In terms of timing, for operational monitoring, 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 required report.String

Response

NAMEDESCRIPTIONTYPE
type_interactionIt is the type of call and its values could be: conference (conference call), inbound (incoming call), internal call (internal call), internal call_inb (internal incoming call), internal call_que (internal call from a queue), out_pre (outbound call in predictive campaign), outbound_ma (outbound call manually initiated), and transfer (transfer call).String
resultIt is the result of the interaction. It can yield the following values: answer machine (answered by a machine), no answer (unanswered), failed (failed), answer (answered), congestion (line congestion), abandon (abandoned), busy (line busy), and chanunavail (channel unavailable for outgoing call).String
dateDate when the call was made.String
telephoneIndicates the phone number.String
customer_idThis corresponds to the customer’s identification number.String
conn_idThis 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/real_time.php?api=calls_last_10',
  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": [
        {
            "type_interaction": "",
            "result": "",
            "date": "",
            "telephone": "",
            "customer_id": "",
            "conn_id": ""
        }
    ]
}
				
			
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