Search
Close this search box.

< / >

APIs

12. Inquire about phone protected by Law 2300

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/information.php?api=law2300_info&nit={{nit}}&phone={{phone}}

Description:

This API allows you to check if a phone number has been blocked by the protection of Law 2300.

Benefit:

It provides a valuable tool for tracking and managing numbers protected by Law 2300, which contributes to better regulatory compliance and more ethical and responsible communication with contacts.

How it works?:

  • The consumption of this API is done using the GET method.
  • To consume this API, you must replace {{wolkvox_server}} in the URL with the nomenclature of the operation’s server.
  • You should use the wolkvox-token: {{token}} in the Header to utilize 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 has been successful.
  • In terms of timing, for operational tracking, you can make a consumption every 5 minutes for the information.
  • Replace {{nit}} with the NIT number of the company validated in the section for Law 2300 of the wolkvox Manager application.
  • Replace {{phone}} with the phone number you wish to query.
  • In your operation, you must have the option ‘Activate Compliance with Law 2300’ enabled.
  • The phone number to be queried must be associated with the NIT configured in the section for Law 2300 in the configuration of the wolkvox Manager application.
  • 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 required report. String

Response

NAME DESCRIPTION TYPE
phone_number Phone number. String
last_day It is the date and time when the phone number was blocked due to the protection of Law 2300. String
last_channel Last channel through which contact was made. It can yield the value ‘voice’, ‘chat’, or ‘whatsapp’. 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=law2300_info&nit={{nit}}&phone={{phone}}',
  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": "x records were found",
    "data": [
        {
            "phone_number": "",
            "last_day": "",
            "last_channel": ""
        }
    ]
}
				
			
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