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

< / >

APIs Configuration

8. Eliminate one or more DNC

URL:

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

Description:

This API allows multiple DNC (Do Not Call) records to be deleted from the module.

Benefit:

Remove in particular locked records from the database externally, without the need to reload the database, optimizing time.

How it works:

  • The consumption of this API is done by DELETE method.
  • In the json the parameters are added according to the operation or process to be performed.
  • To consume this API you must replace in the url {{{wolkvox_server}} by the nomenclature of the server of the operation.
  • The wolkvox-token header must be used to make use of the authorization token.
  • The ‘telephones’ field can receive the parameter ‘All’ if you wish to delete all previously added DNC records: { “telephones”: “All” }
  • 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.
  • You can use {“telephones”: “all”, “type”: “inbound”} to delete only the inbound “Do not call” list phones or you can also use {“telephones”: “all”, “type”: “outbound”} to delete only the outbound “Do not call” list phones.

REQUEST

NAME DESCRIPTION TYPE
telephones Phones to eliminate String

RESPONSE

NAME DESCRIPTION TYPE
code Response code int
error Error String
msg Description of the response 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=remove_dnc',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'DELETE',
  CURLOPT_POSTFIELDS =>'{
    "telephones": [
        "xxxxxxxxxx",
        "xxxxxxxxxx"
    ]
}',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					{
    "code": 202,
    "error": null,
    "msg": "1 telephones were deleted"
}
				
			
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