T2A Web Service

T2A

Click here for a complete list of operations.

tps_full

Determine if a UK landline or mobile number is registered in EITHER the Telephone Preference Scheme (TPS) or the business version (CTPS). 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.

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_full"

<?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_full xmlns="https://api.t2a.io/soap">
      <api_key>string</api_key>
      <client>string</client>
      <telephone_number>string</telephone_number>
    </tps_full>
  </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>
    <tps_fullResponse xmlns="https://api.t2a.io/soap">
      <tps_fullResult>
        <tps_status>string</tps_status>
        <ctps_status>string</ctps_status>
        <telephone_number>string</telephone_number>
        <tps_result_list>
          <tps_result>
            <telephone_number>string</telephone_number>
            <tps_status>string</tps_status>
          </tps_result>
          <tps_result>
            <telephone_number>string</telephone_number>
            <tps_status>string</tps_status>
          </tps_result>
        </tps_result_list>
      </tps_fullResult>
    </tps_fullResponse>
  </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_full xmlns="https://api.t2a.io/soap">
      <api_key>string</api_key>
      <client>string</client>
      <telephone_number>string</telephone_number>
    </tps_full>
  </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>
    <tps_fullResponse xmlns="https://api.t2a.io/soap">
      <tps_fullResult>
        <tps_status>string</tps_status>
        <ctps_status>string</ctps_status>
        <telephone_number>string</telephone_number>
        <tps_result_list>
          <tps_result>
            <telephone_number>string</telephone_number>
            <tps_status>string</tps_status>
          </tps_result>
          <tps_result>
            <telephone_number>string</telephone_number>
            <tps_status>string</tps_status>
          </tps_result>
        </tps_result_list>
      </tps_fullResult>
    </tps_fullResponse>
  </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_full?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_full_res xmlns="https://api.t2a.io/soap">
  <tps_status>string</tps_status>
  <ctps_status>string</ctps_status>
  <telephone_number>string</telephone_number>
  <tps_result_list>
    <tps_result>
      <telephone_number>string</telephone_number>
      <tps_status>string</tps_status>
    </tps_result>
    <tps_result>
      <telephone_number>string</telephone_number>
      <tps_status>string</tps_status>
    </tps_result>
  </tps_result_list>
</tps_full_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_full 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_full_res xmlns="https://api.t2a.io/soap">
  <tps_status>string</tps_status>
  <ctps_status>string</ctps_status>
  <telephone_number>string</telephone_number>
  <tps_result_list>
    <tps_result>
      <telephone_number>string</telephone_number>
      <tps_status>string</tps_status>
    </tps_result>
    <tps_result>
      <telephone_number>string</telephone_number>
      <tps_status>string</tps_status>
    </tps_result>
  </tps_result_list>
</tps_full_res>

Parameter	Value
api_key:
client:
telephone_number: