fbpx
Search
Close this search box.
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.

REQUEST

NAMEDESCRIPTIONTYPE
apiTipo de reporte requerido.String

RESPONSE

NAMEDESCRIPTIONTYPE
phone_numberPhone number.String
last_dayIt is the date and time when the phone number was blocked due to the protection of Law 2300.String
last_channelLast 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-token: {{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