Adding a UK Telephone Preference Service check to your interaction plan
Please note that the TPS check is available for UK numbers only, as TPS operates exclusively in the UK.
Using the Data Connector applet and Web Service interface, you can add a Telephone Preference Service (TPS) check to your interaction plan. If configured for outbound calls, the applet checks every number your agent dials and terminates the call if the number has been registered as a "Do Not Call" in the TPS. If the number has not been registered, the call proceeds according to the interaction plan. If configured for inbound calls, the applet checks every incoming number.
Adding a TPS check to your interaction plan ensures compliance with the UK regulations.
For more information on the Data Connector applet, see Data Connector applet.
Please note that we do not provide a TPS account or a TPS OAuth Token, which are necessary to add a TPS check to your interaction plan.
Configuration
After adding the Data connector applet to your integration plan, configure the following settings:
Interface
Field | Options | Instruction |
|---|---|---|
Interface | List of available interfaces | Select "Web Service". |
Interface failure | List of available applets | Select an applet to which the interaction plan should go if the TPS check was not executed. |
Action
Field | Options | Instruction |
|---|---|---|
Action | List of operations available in the selected interface | Select "Check UK TPS". |
Request/response definition
Field | Instruction |
|---|---|
Request Authorization code | Paste in the OAuth Token from your TPS account. |
Phone number to check | For Inbound calls, enter the "$(CLID)" placeholder. When the interaction plan is executed, the placeholder is replaced with the number calling you. |
For Outbound calls, enter the "$(OutboundDestination)" placeholder. When the interaction plan is executed, the placeholder is replaced with the number you've dialed. |
Routing
Field | Options | Instruction |
|---|---|---|
Successful action | List of available applets | Select an applet to which the interaction plan should go if the number isn't registered in the TPS. |
Failure action | List of available applets | Select an applet to which the interaction plan should go if the called number is returned as "Do Not Call". |
Click Update to save your configuration.
For general assistance, please contact Customer Support.
For help using this documentation, please send an email to docs_feedback@vonage.com. We're happy to hear from you. Your contribution helps everyone at Vonage! Please include the name of the page in your email.