← Telnyx

Get Phone Numbers with Telnyx API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Get Phone Numbers with the Telnyx API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Get Phone Numbers with the Telnyx API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. 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
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Get Phone Numbers with Telnyx API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Telnyx
 
Try it
Get Phone Numbers with Telnyx API on New Submission from Typeform API
Typeform + Telnyx
 
Try it
Get Phone Numbers with Telnyx API on New Submission (Instant) from Jotform API
Jotform + Telnyx
 
Try it
Get Phone Numbers with Telnyx API on New Scheduled Tasks from Pipedream API
Pipedream + Telnyx
 
Try it
Get Phone Numbers with Telnyx API on npm Download Counts from npm API
npm + Telnyx
 
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.

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

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;
  },
};

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.
LabelPropTypeDescription
TelnyxtelnyxAppappThis component uses the Telnyx app.
Page SizepageSizeinteger

The size of the page.

Page NumberpageNumberinteger

The page number to load.

Tagtagstring

Filter by tag.

Phone NumberphoneNumberstring

Filter by phone number. Requires at least three digits. Non-numerical characters will result in no values being returned.

StatusstatusstringSelect a value from the drop down menu:purchase_pendingpurchase_failedport_pendingactivedeletedport_failedemergency_onlyported_outport_out_pending
Connection IdconnectionIdstring

Filter by connection Id.

Containscontainsstring

Filter contains connection name. Requires at least three characters.

Starts WithstartsWithstring

Filter starts with connection name. Requires at least three characters.

Ends WithendsWithstring

Filter ends with connection name. Requires at least three characters.

Equalsequalsstring

Filter by connection name.

Payment MethodpaymentMethodstringSelect a value from the drop down menu:pay-per-minutechannel
Billing Group IdbillingGroupIdstring

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 IdemergencyAddressIdstring

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 ReferencecustomerReferencestring

Filter numbers via the customer reference set.

SortsortstringSelect a value from the drop down menu:purchased_atphone_numberconnection_nameusage_payment_method

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 Use Telnyx

Triggers

New Call Received from the Telnyx API

Emit new event on an incoming call to a Call Control Application. See the documentation

 
Try it
New Phone Number from the Telnyx API

Emit new event when a new phone number is added See the documentation

 
Try it

Actions

Dial Number with the Telnyx API

Dial a number or SIP URI from a given Call Control App. See the documentation

 
Try it
Get Messaging Profiles with the Telnyx API

Get a list of messaging profiles. See the documentation

 
Try it
Retrieve a Message with the Telnyx API

Retrieve a message. See the documentation

 
Try it
Send Fax with the Telnyx API

Sends a PDF document to a specified fax number using the Telnyx Fax API. See the documentation

 
Try it
Send Group Message with the Telnyx API

Send a group MMS message. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,400+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
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.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.