0151 355 4555

IsCallable

Description

Checks if the telephone number is registered with the CTPS, and so cannot be called for unsolicited direct marketing. If the number can be called for marketing purposes, the Callable field of the CTPSOutput structure returned by the service will be set to true. Otherwise, it will be set to false. In either case, the TelephoneNumber field of the structure will be set to the same value as was supplied as the number parameter.

View all CTPS (part of the data validation suite) methods

Code Samples

<!-- Import the Integr8 Ajax API -->
<!-- NOTE: Get your own API key to use in the following script tag from: -->
<!-- http://www.data-8.co.uk/integr8/Admin/Ajax.aspx -->
<script src="https://webservices.data-8.co.uk/Javascript/Loader.ashx?key=your-api-key" type="text/javascript">
</script>

<script type="text/javascript">

function loadIntegr8() {
  // Load the CTPS Integr8 service
  data8.load('CTPS');
}

function IsCallable(number) {
  /// <param name="number">string</param>
  var ctps = new data8.ctps();
  
  ctps.iscallable(
    number,
    null,
    showIsCallableResult
  );
}

function showIsCallableResult(result) {
  // Check that the call succeeded, and show the error message if there was a problem.
  if (!result.Status.Success) {
    alert('Error: ' + result.Status.ErrorMessage);
  }
  else {
    // TODO: Process method results here.
    // Results can be extracted from the following fields:
    // result.Callable
    //   Indicates if the supplied telephone number is callable (i.e. not on the CTPS)
    // result.TelephoneNumber
    //   Contains the original telephone number if it is callable.
  }
}

loadIntegr8();

</script>