Phone Number Validation with Ideal Postcodes API

Pipedream makes it easy to connect APIs for Ideal Postcodes and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Phone Number Validation with the Ideal Postcodes API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Phone Number Validation with the Ideal Postcodes API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Phone Number Validation action
1. Connect your Ideal Postcodes account
2. Configure Phone Number
3. Optional- Configure Current Carrier
4. Optional- Configure Tags
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Phone Number Validation with Ideal Postcodes API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Ideal Postcodes

Try it

Phone Number Validation with Ideal Postcodes API on New Submission from Typeform API

Typeform + Ideal Postcodes

Try it

Phone Number Validation with Ideal Postcodes API on New Submission (Instant) from Jotform API

Jotform + Ideal Postcodes

Try it

Phone Number Validation with Ideal Postcodes API on New Scheduled Tasks from Pipedream API

Pipedream + Ideal Postcodes

Try it

Phone Number Validation with Ideal Postcodes API on New Download Counts from npm API

npm + Ideal Postcodes

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Phone Number Validation on Ideal Postcodes

Description:Validates a phone number and returns information about it. [See the documentation](https://docs.ideal-postcodes.co.uk/docs/api/phone-number-validation).

Version:0.0.1

Key:ideal_postcodes-phone-number-validation

View on GitHub

Code#

import app from "../../ideal_postcodes.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "ideal_postcodes-phone-number-validation",
  name: "Phone Number Validation",
  description: "Validates a phone number and returns information about it. [See the documentation](https://docs.ideal-postcodes.co.uk/docs/api/phone-number-validation).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    query: {
      type: "string",
      label: "Phone Number",
      description: "Specifies the phone number to validate. Phone number must include a country code in acceptable format. For instance, UK phone numbers should be suffixed `+44`, `44` or `0044`.",
    },
    currentCarrier: {
      type: "boolean",
      label: "Current Carrier",
      description: "When set to `true` the current network of the phone number will be retrieved and populated. Note that this operation is potentially slow depending on the network and local conditions.",
      optional: true,
    },
    tags: {
      propDefinition: [
        app,
        "tags",
      ],
    },
  },
  methods: {
    validatePhoneNumber(args = {}) {
      return this.app._makeRequest({
        path: "/phone_numbers",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      validatePhoneNumber,
      query,
      currentCarrier,
      tags,
    } = this;

    const response = await validatePhoneNumber({
      $,
      params: {
        query,
        current_carrier: currentCarrier,
        tags: utils.encode(tags),
      },
    });

    $.export("$summary", `Successfully validated phone number with message \`${response.message}\``);

    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Ideal Postcodes	`app`	`app`	This component uses the Ideal Postcodes app.
Phone Number	`query`	`string`	Specifies the phone number to validate. Phone number must include a country code in acceptable format. For instance, UK phone numbers should be suffixed `+44`, `44` or `0044`.
Current Carrier	`currentCarrier`	`boolean`	When set to `true` the current network of the phone number will be retrieved and populated. Note that this operation is potentially slow depending on the network and local conditions.
Tags	`tags`	`string`	A comma separated list of tags to query over. Useful if you want to specify the circumstances in which the request was made. If multiple tags are specified, the response will only comprise of requests for which all the tags are satisfied - i.e. searching `foo,bar` will only query requests which tagged both `foo` and `bar`.