View as Markdown
Telnyx icon

Telnyx ACTION

Get Phone Numbers

Get a list of phone numbers. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Telnyx account once, then configure and run Get Phone Numbers from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "telnyx-get-phone-numbers",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    telnyx: { authProvisionId: "apn_xxxxxxx" },
    pageSize: 10,
    pageNumber: 10,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Phone Numbers inputs
Property Type Description
pageSize Page Size integer
The size of the page.
Optional
pageNumber Page Number integer
The page number to load.
Optional
tag Tag string
Filter by tag.
Optional
phoneNumber Phone Number string
Filter by phone number. Requires at least three digits. Non-numerical characters will result in no values being returned.
Optional
status Status string
Filter by phone number status.
Optional
connectionId Connection Id string
Filter by connection Id.
Optional
contains Contains string
Filter contains connection name. Requires at least three characters.
Optional
startsWith Starts With string
Filter starts with connection name. Requires at least three characters.
Optional
endsWith Ends With string
Filter ends with connection name. Requires at least three characters.
Optional
equals Equals string
Filter by connection name.
Optional
paymentMethod Payment Method string
Filter by usage payment method.
Optional
billingGroupId Billing Group Id 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'.
Optional
emergencyAddressId Emergency Address Id 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'.
Optional
customerReference Customer Reference string
Filter numbers via the customer reference set.
Optional
sort Sort string
Specifies the sort order for results. If not given, results are sorted by created_at in descending order.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
telnyx-get-phone-numbers
Version
0.0.5
App
Telnyx
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes