Send SMS with Twilio API on New Contact from Textlocal API

Pipedream makes it easy to connect APIs for Twilio, Textlocal and 2,000+ other apps remarkably fast.

Trigger workflow on

New Contact from the Textlocal API

Next, do this

Send SMS with the Twilio API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Textlocal trigger and Twilio action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Contact trigger
1. Connect your Textlocal account
2. Configure timer
3. Select a Contact Group
Configure the Send SMS action
1. Connect your Twilio account
2. Select a From
3. Configure To
4. Configure Message Body
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Contact on Textlocal

Description:Emit new contact

Version:0.0.3

Key:textlocal-new-contact

View on GitHub

Textlocal Overview#

The Textlocal API on Pipedream allows for robust SMS messaging capabilities within workflows. You can send notifications, alerts, and updates directly to mobile users, automate marketing campaigns, or integrate SMS into multi-channel communication strategies. By leveraging Pipedream's serverless platform, you can create complex workflows involving Textlocal for various application domains without managing infrastructure, boosting productivity and engagement through the power of automated text messaging.

Trigger Code#

import common from "../common/timer-based.mjs";

export default {
  ...common,
  key: "textlocal-new-contact",
  name: "New Contact",
  description: "Emit new contact",
  type: "source",
  version: "0.0.3",
  dedupe: "unique",
  props: {
    ...common.props,
    groupId: {
      type: "string",
      label: "Contact Group",
      description: "The contact group to monitor for new contacts",
      async options(context) {
        const { page } = context;
        if (page !== 0) {
          return [];
        }

        const { groups } = await this.textlocal.getGroups();
        const options = groups.map((group) => ({
          label: group.name,
          value: group.id,
        }));
        return {
          options,
        };
      },
    },
  },
  hooks: {
    ...common.hooks,
    deactivate() {
      this.db.set("isInitialized", false);
    },
  },
  methods: {
    ...common.methods,
    _isContactProcessed(contact) {
      const { number } = contact;
      return Boolean(this.db.get(number));
    },
    _markContactAsProcessed(contact) {
      const { number } = contact;
      this.db.set(number, true);
    },
    async takeContactGroupSnapshot() {
      const contactScan = await this.textlocal.scanContactGroup({
        groupId: this.groupId,
      });

      for await (const contact of contactScan) {
        this._markContactAsProcessed(contact);
      }
    },
    generateMeta({
      contact,
      ts,
    }) {
      const {
        number,
        first_name: firstName,
        last_name: lastName,
      } = contact;
      const maskedName = this.getMaskedName({
        firstName,
        lastName,
      });
      const maskedNumber = this.getMaskedNumber(number);
      const summary = `New contact: ${maskedName} (${maskedNumber})`;
      return {
        id: number,
        summary,
        ts,
      };
    },
    async processEvent(event) {
      const isInitialized = this.db.get("isInitialized");
      if (!isInitialized) {
        await this.takeContactGroupSnapshot();
        this.db.set("isInitialized", true);
        return;
      }

      const { timestamp: ts } = event;
      const contactScan = await this.textlocal.scanContactGroup({
        groupId: this.groupId,
      });

      for await (const contact of contactScan) {
        if (this._isContactProcessed(contact)) {
          continue;
        }

        const meta = this.generateMeta({
          contact,
          ts,
        });
        this.$emit(contact, meta);
        this._markContactAsProcessed(contact);
      }
    },
  },
};

Trigger 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
Textlocal	`textlocal`	`app`	This component uses the Textlocal app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Contact Group	`groupId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Textlocal uses API keys for authentication. When you connect your Textlocal account, Pipedream securely stores the keys so you can easily authenticate to Textlocal APIs in both code and no-code steps.

Get your api key in your settings > API keys.

About Textlocal#

Bulk SMS Marketing Service for Business | Send ...

Action#

Send SMS on Twilio

Description:Send a simple text-only SMS. [See the docs](https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource) for more information

Version:0.1.3

Key:twilio-send-sms

View on GitHub

Twilio Overview#

Twilio's API on Pipedream opens up a multitude of communication capabilities, allowing you to build robust, scalable, and automated workflows. With Twilio, you can send and receive SMS and MMS messages, make voice calls, and perform other communication functions programmatically. Leveraging Pipedream's seamless integration, you can connect these communications features with hundreds of other services to automate notifications, streamline customer interactions, and enhance operational efficiency.

Action Code#

import { phone } from "phone";
import twilio from "../../twilio.app.mjs";
import { messageToString } from "../../common/utils.mjs";

export default {
  key: "twilio-send-sms",
  name: "Send SMS",
  description: "Send a simple text-only SMS. [See the docs](https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource) for more information",
  type: "action",
  version: "0.1.3",
  props: {
    twilio,
    from: {
      propDefinition: [
        twilio,
        "from",
      ],
    },
    to: {
      propDefinition: [
        twilio,
        "to",
      ],
    },
    body: {
      propDefinition: [
        twilio,
        "body",
      ],
    },
  },
  async run({ $ }) {
    // Parse the given number into its E.164 equivalent
    // The E.164 phone number will be included in the first element
    // of the array, but the array will be empty if parsing fails.
    // See https://www.npmjs.com/package/phone
    const toParsed = phone(this.to);
    if (!toParsed || !toParsed.phoneNumber) {
      throw new Error(`Phone number ${this.to} could not be parsed as a valid number.`);
    }

    const fromParsed = phone(this.from);
    if (!fromParsed || !fromParsed.phoneNumber) {
      throw new Error(`Phone number ${this.from} could not be parsed as a valid number.`);
    }

    const data = {
      to: toParsed.phoneNumber,
      from: fromParsed.phoneNumber,
      body: this.body,
    };

    const resp = await this.twilio.getClient().messages.create(data);
    $.export("$summary", `Successfully sent a new SMS, "${messageToString(resp)}"`);
    return resp;
  },
};

Action Configuration#

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

Label	Prop	Type	Description
Twilio	`twilio`	`app`	This component uses the Twilio app.
From	`from`	`string`	Select a value from the drop down menu.
To	`to`	`string`	The destination phone number in E.164 format. Format with a `+` and country code (e.g., `+16175551212`).
Message Body	`body`	`string`	The text of the message you want to send, limited to 1600 characters.

Action Authentication#

Twilio uses API keys for authentication. When you connect your Twilio account, Pipedream securely stores the keys so you can easily authenticate to Twilio APIs in both code and no-code steps.

To connect your Twilio account to Pipedream,

API Key and API Key SID

First, create an API key in Twilio.

There are three types of keys: Main, Standard, and Restricted. You'll need a Main key to interact with certain API endpoints, like /Accounts.
If you don't need to interact with those endpoints, you can use a Standard or Restricted key.

After creating your key, you'll see fields for Sid and Secret. Enter those in the fields below.

Account SID and Auth Token

Visit your Twilio Dashboard. You'll see your Account SID and Auth Token under Account info.

About Twilio#

Twilio is a cloud communications platform for building SMS, Voice & Messaging applications on an API built for global scale.

More Ways to Connect Twilio + Textlocal#

Other Popular Integrations#

Create Contact with Textlocal API on New Call (Instant) from Twilio API

Twilio + Textlocal