NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Tpscheck connects to a Nagent workspace with an API key. Once it is connected, agents can call 1 Tpscheck action: "Check Phone Number (TPS/CTPS)". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Tpscheck, with input parameters and output schema.
TPSCHECK_CHECK_PHONE_NUMBERChecks if one or more UK phone numbers are registered on the Telephone Preference Service (TPS) and/or Corporate Telephone Preference Service (CTPS) lists using the tpsapi.com API.
Input parameters
Set to true to check numbers against the TPS list.
Set to true to check numbers against the CTPS list.
Set to true to prevent full numbers from being stored in logs for privacy. Only the first 6 digits will be saved.
A list of UK phone numbers to check. Maximum 10,000 numbers per request.
Set to true to include the date the number was added to a list (if found).
Set to true to include a formatted version of the phone number in the response.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 1 Tpscheck action on Nagent: "Check Phone Number (TPS/CTPS)". Check Phone Number (TPS/CTPS): Checks if one or more UK phone numbers are registered on the Telephone Preference Service (TPS) and/or Corporate Telephone Preference Service (CTPS) lists using the tpsapi.com API. Each action is listed on this page with its input parameters and its output.
Tpscheck connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Check Phone Number (TPS/CTPS) takes 1 required input: phone_numbers. It also takes 5 optional inputs: check_tps, check_ctps, no_logging, return_date_added and return_prettier_numbers. It returns data, error and successful.