Search
Close this search box.

< / >

APIs

11. List Do Not Call Phone Numbers

URL:

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

Description:

This API allows for detailed tracking of numbers entered into the DNC list.

Benefit:

It provides a valuable tool for the tracking and effective management of numbers on the exclusion list, contributing to better regulatory compliance and more ethical and responsible communication with contacts.

How it works?

  • The consumption of this API is done via the GET method.
  • To consume this API, you must replace {{wolkvox_server}} in the URL with the server nomenclature for the operation.
  • 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 {{type}} with the type of call to be searched. You can use “inbound” to retrieve the list of DNC numbers for inbound calls, “outbound” for outbound calls, or “all” to retrieve data for both inbound and outbound calls.
  • 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 report required String

 

Response

NAME DESCRIPTION TYPE
phone_number Phone number. String
type Type of call. It can return the value ‘inbound’ for incoming calls or ‘outbound’ for outgoing calls. String
date_delete Indicates the date when the phone number was added to the DNC list. 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_dnc&type={{type}}',
  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": "",
            "type": "",
            "date_delete": ""
        }
    ]
}
				
			
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