T2A


Click here for a complete list of operations.

tps

Determine if a UK residential landline or mobile number is registered in the Telephone Preference Scheme (TPS). Returns 'no_call' if the number may not receive unsolicited marketing calls, or 'call' if the number is not registered with TPS.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
api_key:
client:
telephone_number:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /soap/t2a.asmx HTTP/1.1
Host: api.t2a.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.t2a.io/soap/tps"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <tps xmlns="https://api.t2a.io/soap">
      <api_key>string</api_key>
      <client>string</client>
      <telephone_number>string</telephone_number>
    </tps>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <tpsResponse xmlns="https://api.t2a.io/soap">
      <tpsResult>
        <tps_status>string</tps_status>
        <telephone_number>string</telephone_number>
      </tpsResult>
    </tpsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /soap/t2a.asmx HTTP/1.1
Host: api.t2a.io
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <tps xmlns="https://api.t2a.io/soap">
      <api_key>string</api_key>
      <client>string</client>
      <telephone_number>string</telephone_number>
    </tps>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <tpsResponse xmlns="https://api.t2a.io/soap">
      <tpsResult>
        <tps_status>string</tps_status>
        <telephone_number>string</telephone_number>
      </tpsResult>
    </tpsResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /soap/t2a.asmx/tps?api_key=string&client=string&telephone_number=string HTTP/1.1
Host: api.t2a.io

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<tps_res xmlns="https://api.t2a.io/soap">
  <tps_status>string</tps_status>
  <telephone_number>string</telephone_number>
</tps_res>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /soap/t2a.asmx/tps HTTP/1.1
Host: api.t2a.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

api_key=string&client=string&telephone_number=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<tps_res xmlns="https://api.t2a.io/soap">
  <tps_status>string</tps_status>
  <telephone_number>string</telephone_number>
</tps_res>