fbpx

< / >

APIs

24. Number blocking for Law 2300

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/configuration.php?api=block_law2300

Description:

This API allows you to add phone numbers to the “non-contactable” list under the parameters of Law 2300 (Colombia), a consumer protection regulation available in Wolkvox Manager. Its main purpose is to facilitate compliance with this law, ensuring that certain numbers are not contacted or that communication is handled according to the established restrictions—even if the operation is located outside Colombia.

Benefits:

  • Regulatory compliance: Supports adherence to Law 2300 “Stop bothering” (Colombia) and similar consumer protection regulations, regardless of the geographical location of the operation.
  • Efficient contact management: Allows phone numbers to be added and updated in the non-contactable list programmatically, automating what would otherwise be a manual process.
  • Error reduction: Built-in validations minimize the risk of mistakes when adding or updating numbers.
  • Data consistency:  Normalizes the format of phone numbers, ensuring uniformity in the “non-contactable” database.
  • Improved customer experience: Helps improve customer perception of the company by blocking unwanted or repetitive contacts.
  • Regional flexibility:  Although the law name refers specifically to Colombia, its features are applicable and beneficial for operations in any country looking to manage contacts similarly.

How it works:

  • This API is consumed using the PUT method.
  • Parameters are included in the JSON body according to the operation or process to be performed.
  • To use this API, replace {{wolkvox_server}} in the URL with the naming convention of your operation’s server.
  • Use the header wolkvox-token: {{token}} to include the authorization token.
  • Important: The same token cannot be used for simultaneous requests. You should program the next API call only after the previous one returns a successful result.

Limits:

  • Download limit per request: 60,000 records
  • Upload limit per request: 10,000 records
  • Date range limit for queries: 31 days
  • Response size limit: 256 MB
  • API request timeout: 60 seconds
  • Simultaneous token usage: Maximum of 2 concurrent requests
  • Daily token limit: Number of licenses × 1,000 tokens per day

Code Examples:

In our Postman workspace ([click here] to access it), you have access to code examples that facilitate integration with our APIs in different programming languages such as cURL, Python, JavaScript, and more.

This feature is ideal for quick integrations and allows you to adapt the API calls to your system’s programming language.

How to Use the Code Examples:

  1. Navigate to our Postman workspace.
  2. Select the API you want to consult.
  3. Edit the necessary API parameters according to your goals.
  4. In the “Code” tab, select your preferred programming language.
  5. You will get an auto-generated code snippet, ready to use with the parameters and authentication previously configured.

Request

NAMEDESCRIPTIONTYPE
nitNIT associated with the company where the client is registered.String
telephoneThe phone number to be added to the “non-contactable” list. This field is mandatory.String
customer_idThe client identifier associated with the phone number.String

Response

NAMEDESCRIPTIONTYPE
codeResponse code.int
errorError.String
msgResponse description.String
Possible Response Codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/configuration.php?api=block_law2300',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_POSTFIELDS =>'{
    "nit": "",
    "telephone": "",
    "customer_id": ""
}',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{wolkvox-token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "The number has been blocked successfully"
}
				
			

Usamos cookies, se continuar a navegar assumimos que concorda. Pode ler mais sobre a utilização de cookies nas nossas políticas de privacidade e tratamento de dados pessoais

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