Get Phone Numbers with Telnyx API on New Contact from Twilio SendGrid API

Pipedream makes it easy to connect APIs for Telnyx, Twilio SendGrid and 2,400+ other apps remarkably fast.

Trigger workflow on

New Contact from the Twilio SendGrid API

Next, do this

Get Phone Numbers with the Telnyx 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#

This integration creates a workflow with a Twilio SendGrid trigger and Telnyx 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 Twilio SendGrid account
2. Configure timer
Configure the Get Phone Numbers action
1. Connect your Telnyx account
2. Optional- Configure Page Size
3. Optional- Configure Page Number
4. Optional- Configure Tag
5. Optional- Configure Phone Number
6. Optional- Select a Status
7. Optional- Configure Connection Id
8. Optional- Configure Contains
9. Optional- Configure Starts With
10. Optional- Configure Ends With
11. Optional- Configure Equals
12. Optional- Select a Payment Method
13. Optional- Configure Billing Group Id
14. Optional- Configure Emergency Address Id
15. Optional- Configure Customer Reference
16. Optional- Select a Sort
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 Twilio SendGrid

Description:Emit new event when a new contact is created

Version:0.0.6

Key:sendgrid-new-contact

View on GitHub

Twilio SendGrid Overview#

The Twilio SendGrid API opens up a world of possibilities for email automation, enabling you to send emails efficiently and track their performance. With this API, you can programmatically create and send personalized email campaigns, manage contacts, and parse inbound emails for data extraction. When you harness the power of Pipedream, you can connect SendGrid to hundreds of other apps to automate workflows, such as triggering email notifications based on specific actions, syncing email stats with your analytics, or handling incoming emails to create tasks or tickets.

Trigger Code#

import orderBy from "lodash/orderBy.js";
import common from "../common/timer-based.mjs";

export default {
  ...common,
  key: "sendgrid-new-contact",
  name: "New Contact",
  description: "Emit new event when a new contact is created",
  version: "0.0.6",
  type: "source",
  dedupe: "unique",
  hooks: {
    async activate() {
      const currentTimestamp = Date.now();
      const state = {
        processedItems: [],
        lowerTimestamp: currentTimestamp,
        upperTimestamp: currentTimestamp,
      };
      this.db.set("state", state);
    },
  },
  methods: {
    ...common.methods,
    _maxDelayTime() {
      // There is no report from SendGrid as to how much time it takes
      // for a contact to be created and appear in search results, so
      // we're using a rough estimate of 30 minutes here.
      return 30 * 60 * 1000;  // 30 minutes, in milliseconds
    },
    _addDelayOffset(timestamp) {
      return timestamp - this._maxDelayTime();
    },
    _cleanupOldProcessedItems(processedItems, currentTimestamp) {
      return processedItems
        .map((item) => ({
          // We just need to keep track of the record ID and
          // its creation date.
          id: item.id,
          created_at: item.created_at,
        }))
        .filter((item) => {
          const { created_at: createdAt } = item;
          const createdAtTimestamp = Date.parse(createdAt);
          const cutoffTimestamp = this._addDelayOffset(currentTimestamp);
          return createdAtTimestamp > cutoffTimestamp;
        });
    },
    _makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp) {
      const idList = processedItems
        .map((item) => item.id)
        .map((id) => `'${id}'`)
        .join(", ")
      || "''";
      const startTimestamp = this._addDelayOffset(lowerTimestamp);
      const startDate = this.toISOString(startTimestamp);
      const endDate = this.toISOString(upperTimestamp);
      return `
        contact_id NOT IN (${idList}) AND
        created_at BETWEEN
          TIMESTAMP '${startDate}' AND
          TIMESTAMP '${endDate}'
      `;
    },
    generateMeta(data) {
      const {
        item,
        eventTimestamp: ts,
      } = data;
      const {
        id,
        email,
      } = item;
      const slugifiedEmail = this.slugifyEmail(email);
      const summary = `New contact: ${slugifiedEmail}`;
      return {
        id,
        summary,
        ts,
      };
    },
    async processEvent(event) {
      // Transform the timer timestamp to milliseconds
      // to be consistent with how Javascript handles timestamps.
      const eventTimestamp = event.timestamp * 1000;

      // Retrieve the current state of the component.
      const {
        processedItems,
        lowerTimestamp,
        upperTimestamp,
      } = this.db.get("state");

      // Search for contacts within a specific timeframe, excluding
      // items that have already been processed.
      const query = this._makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp);
      const {
        result: items,
        contact_count: contactCount,
      } = await this.sendgrid.searchContacts(query);

      // If no contacts have been retrieved via the API,
      // move the time window forward to possibly capture newer contacts.
      if (contactCount === 0) {
        const newState = {
          processedItems: this._cleanupOldProcessedItems(processedItems, lowerTimestamp),
          lowerTimestamp: upperTimestamp,
          upperTimestamp: eventTimestamp,
        };
        this.db.set("state", newState);
        return;
      }

      // We process the searched records from oldest to newest.
      const itemsToProcess = orderBy(items, "created_at");
      itemsToProcess
        .forEach((item) => {
          const meta = this.generateMeta({
            item,
            eventTimestamp,
          });
          this.$emit(item, meta);
        });

      // Use the timestamp of the last processed record as a lower bound for
      // following searches. This bound will be subjected to an offset so in
      // case older records appear in future search results, but have not
      // appeared until now, can be processed. We only adjust it if it means
      // moving forward, not backwards. Otherwise, we might start retrieving
      // older and older records indefinitely (and we're all about *new*
      // records!)
      const newLowerTimestamp = Math.max(
        lowerTimestamp,
        Date.parse(itemsToProcess[0].created_at),
      );

      // If the total contact count is less than 100, it means that during the
      // next iteration the search results count will most likely be less than
      // 50. In that case, if we extend the upper bound of the search time range
      // we might be able to retrieve more records.
      const newUpperTimestamp = contactCount < 100
        ? eventTimestamp
        : upperTimestamp;

      // The list of processed items can grow indefinitely.
      // Since we don't want to keep track of every processed record
      // ever, we need to clean up this list, removing any records
      // that are no longer relevant.
      const newProcessedItems = this._cleanupOldProcessedItems(
        [
          ...processedItems,
          ...itemsToProcess,
        ],
        newLowerTimestamp,
      );

      // Update the state of the component to reflect the computations
      // made above.
      const newState = {
        processedItems: newProcessedItems,
        lowerTimestamp: newLowerTimestamp,
        upperTimestamp: newUpperTimestamp,
      };
      this.db.set("state", newState);
    },
  },
};

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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid app.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

About Twilio SendGrid#

Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.

Action#

Get Phone Numbers on Telnyx

Description:Get a list of phone numbers. [See the documentation](https://developers.telnyx.com/api/numbers/list-phone-numbers)

Version:0.0.4

Key:telnyx-get-phone-numbers

View on GitHub

Telnyx Overview#

The Telnyx API offers a suite of telecommunication features enabling developers to manage voice, SMS, and other real-time communications. With Telnyx, you can programmatically send and receive text messages, handle voice calls, and control other telephony services using their robust API. Leveraging Pipedream's capabilities, this API can be hooked into workflows to automate complex tasks, react to incoming messages or calls, and integrate with countless other services for analytics, customer support, and more.

Action Code#

import telnyxApp from "../../telnyx.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "telnyx-get-phone-numbers",
  name: "Get Phone Numbers",
  description: "Get a list of phone numbers. [See the documentation](https://developers.telnyx.com/api/numbers/list-phone-numbers)",
  version: "0.0.4",
  type: "action",
  props: {
    telnyxApp,
    pageSize: {
      type: "integer",
      label: "Page Size",
      description: "The size of the page.",
      optional: true,
      min: 1,
      max: 250,
      default: 20,
    },
    pageNumber: {
      type: "integer",
      label: "Page Number",
      description: "The page number to load.",
      optional: true,
      min: 1,
      default: 1,
    },
    tag: {
      type: "string",
      label: "Tag",
      description: "Filter by tag.",
      optional: true,
    },
    phoneNumber: {
      type: "string",
      label: "Phone Number",
      description: "Filter by phone number. Requires at least three digits. Non-numerical characters will result in no values being returned.",
      optional: true,
    },
    status: {
      type: "string",
      label: "Status",
      description: "Filter by phone number status.",
      options: Object.values(constants.phoneNumberStatus),
      optional: true,
    },
    connectionId: {
      type: "string",
      label: "Connection Id",
      description: "Filter by connection Id.",
      optional: true,
    },
    contains: {
      type: "string",
      label: "Contains",
      description: "Filter contains connection name. Requires at least three characters.",
      optional: true,
    },
    startsWith: {
      type: "string",
      label: "Starts With",
      description: "Filter starts with connection name. Requires at least three characters.",
      optional: true,
    },
    endsWith: {
      type: "string",
      label: "Ends With",
      description: "Filter ends with connection name. Requires at least three characters.",
      optional: true,
    },
    equals: {
      type: "string",
      label: "Equals",
      description: "Filter by connection name.",
      optional: true,
    },
    paymentMethod: {
      type: "string",
      label: "Payment Method",
      description: "Filter by usage payment method.",
      options: Object.values(constants.paymentMethods),
      optional: true,
    },
    billingGroupId: {
      type: "string",
      label: "Billing Group Id",
      description: "Filter by the billing group Id associated with phone numbers. To filter to only phone numbers that have no billing group associated them, set the value of this filter to the string 'null'.",
      optional: true,
    },
    emergencyAddressId: {
      type: "string",
      label: "Emergency Address Id",
      description: "Filter by the emergency_address_id associated with phone numbers. To filter only phone numbers that have no emergency address associated with them, set the value of this filter to the string 'null'.",
      optional: true,
    },
    customerReference: {
      type: "string",
      label: "Customer Reference",
      description: "Filter numbers via the customer reference set.",
      optional: true,
    },
    sort: {
      type: "string",
      label: "Sort",
      description: "Specifies the sort order for results. If not given, results are sorted by created_at in descending order.",
      options: Object.values(constants.sortPhoneNumbers),
      optional: true,
    },
  },
  async run({ $ }) {
    const phoneNumbers = await this.telnyxApp.getPhoneNumbers({
      $,
      params: {
        "page[size]": this.pageSize || 20,
        "page[number]": this.pageNumber || 1,
        "filter[tag]": this.tag,
        "filter[phone_number]": this.phoneNumber,
        "filter[status]": this.status,
        "filter[connection_id]": this.connectionId,
        "filter[voice.connection_name][contains]": this.contains,
        "filter[voice.connection_name][starts_with]": this.startsWith,
        "filter[voice.connection_name][ends_with]": this.endsWith,
        "filter[voice.connection_name][eq]": this.equals,
        "filter[voice.usage_payment_method]": this.paymentMethod,
        "filter[billing_group_id]": this.billingGroupId,
        "filter[emergency_address_id]": this.emergencyAddressId,
        "filter[customer_reference]": this.customerReference,
        "sort": this.sort,
      },
    });
    $.export("$summary", `Successfully retrieved ${phoneNumbers.data.length} phone number${phoneNumbers.data.length === 1
      ? ""
      : "s"}.`);
    return phoneNumbers;
  },
};

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
Telnyx	`telnyxApp`	`app`	This component uses the Telnyx app.
Page Size	`pageSize`	`integer`	The size of the page.
Page Number	`pageNumber`	`integer`	The page number to load.
Tag	`tag`	`string`	Filter by tag.
Phone Number	`phoneNumber`	`string`	Filter by phone number. Requires at least three digits. Non-numerical characters will result in no values being returned.
Status	`status`	`string`	Select a value from the drop down menu:`purchase_pendingpurchase_failedport_pendingactivedeletedport_failedemergency_onlyported_outport_out_pending`
Connection Id	`connectionId`	`string`	Filter by connection Id.
Contains	`contains`	`string`	Filter contains connection name. Requires at least three characters.
Starts With	`startsWith`	`string`	Filter starts with connection name. Requires at least three characters.
Ends With	`endsWith`	`string`	Filter ends with connection name. Requires at least three characters.
Equals	`equals`	`string`	Filter by connection name.
Payment Method	`paymentMethod`	`string`	Select a value from the drop down menu:`pay-per-minutechannel`
Billing Group Id	`billingGroupId`	`string`	Filter by the billing group Id associated with phone numbers. To filter to only phone numbers that have no billing group associated them, set the value of this filter to the string 'null'.
Emergency Address Id	`emergencyAddressId`	`string`	Filter by the emergency_address_id associated with phone numbers. To filter only phone numbers that have no emergency address associated with them, set the value of this filter to the string 'null'.
Customer Reference	`customerReference`	`string`	Filter numbers via the customer reference set.
Sort	`sort`	`string`	Select a value from the drop down menu:`purchased_atphone_numberconnection_nameusage_payment_method`