fbpx
Search
Close this search box.
Search
Close this search box.

< / >

APIs Information

13. List IP’s

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/information.php?api=get_ip

Description:

This API allows you to list the IP’s registered in your operation.

Benefit:

By using this API, you obtain the latest usage of the IP, type of IP, and description.

How it works?

  • The consumption of this API is done using the GET method.
  • Replace {{wolkvox_server}} in the URL with the nomenclature of your operation on the server.
  • You must use “wolkvox-token: {{token}}” in the HEADER and replace {{token}} with the authorization token generated in your wolkvox operation.
  • 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.
  • 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
token Token code generated in the wolkvox Manager application. INT
wolkvox_server Server nomenclature where your operation is located. This code is provided by support staff. INT

Response

NAME DESCRIPTION TYPE
code Indicates the status code of the response. String
error Provides detailed information about any errors that may occur during the execution of the API. The value ‘null’ indicates that no errors occurred, and the API execution was successful. String
msg It is an informative message that describes the response. String
data It contains the data or set of data obtained when consuming the API. JSON Object
operation Indicates the name of the operation to which the IP is linked. String
ip It is the linked IP address. String
last_use Indicates the date and time of the last use of the IP. String
type_ip Indicates the type of IP. It can yield the value ‘temporary’ or ‘permanent’. String
description Provides the optional description of the IP, which is entered when adding an IP. String
Possible error codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/information.php?api=get_ip',
  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: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "x records were found",
    "data": [
        {
            "operation": "",
            "ip": "",
            "last_use": "",
            "type_ip": "",
            "description": ""
        }
    ]
}
				
			
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