Get Phone Numbers with Telnyx API on New Incoming SMS (Instant) from Twilio API

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

Trigger workflow on

New Incoming SMS (Instant) from the Twilio 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 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 Incoming SMS (Instant) trigger
1. Connect your Twilio account
2. Select a Incoming Phone Number
3. Optional- Configure Response Message
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 Incoming SMS (Instant) on Twilio

Description:Emit new event every time an SMS is sent to the phone number set. Configures a webhook in Twilio, tied to an incoming phone number.

Version:0.1.4

Key:twilio-new-incoming-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.

Trigger Code#

import twilio from "twilio";
import common from "../common/common-webhook.mjs";
import constants from "../../common/constants.mjs";

const MessagingResponse = twilio.twiml.MessagingResponse;

export default {
  ...common,
  key: "twilio-new-incoming-sms",
  name: "New Incoming SMS (Instant)",
  description: "Emit new event every time an SMS is sent to the phone number set. Configures a webhook in Twilio, tied to an incoming phone number.",
  version: "0.1.4",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    responseMessage: {
      propDefinition: [
        common.props.twilio,
        "responseMessage",
      ],
    },
  },
  methods: {
    ...common.methods,
    getServiceType() {
      return constants.SERVICE_TYPE.SMS;
    },
    getResponseBody() {
      const twiml = new MessagingResponse();
      let responseBody = "<Response></Response>";
      if (this.responseMessage) {
        twiml.message(this.responseMessage);
        responseBody = twiml.toString();
      }
      return responseBody;
    },
    generateMeta(body, headers) {
      return {
        /** if Twilio retries a message, but we've already emitted, dedupe */
        id: headers["i-twilio-idempotency-token"],
        summary: body.Body,
        ts: Date.now(),
      };
    },
  },
};

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
Twilio	`twilio`	`app`	This component uses the Twilio app.
Incoming Phone Number	`incomingPhoneNumber`	`string`	Select a value from the drop down menu.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Response Message	`responseMessage`	`string`	The message you want to send in response to incoming messages. Leave this blank if you don't need to issue a response.

Trigger 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.

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`

Action Authentication#

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

The Telnyx API V2 uses API Keys to authenticate requests. You can view and manage your API Keys by logging into your Mission Control Portal account and navigating to the Auth V2 tab in the "Auth" section. See docs.

About Telnyx#

Connectivity Made Simple

More Ways to Connect Telnyx + Twilio#

Other Popular Integrations#

Get Messaging Profiles with Telnyx API on New Call (Instant) from Twilio API

Twilio + Telnyx