View as Markdown
Telnyx icon

Telnyx ACTION

Dial Number

Dial a number or SIP URI from a given Call Control App. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Telnyx account once, then configure and run Dial Number 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-dial-number",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    telnyx: { authProvisionId: "apn_xxxxxxx" },
    callControlAppId: "Call Control Application ID",
    phoneNumber: "Phone Number",
  },
})

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.

Dial Number inputs
Property Type Description
callControlAppId Call Control Application ID string
The ID of the Call Control App to be used when dialing the destination.
Required Dynamic
phoneNumber Phone Number string
The phone number to send the message from.
Required Dynamic
to To string
The DID or SIP URI to dial out to
Required
fromDisplayName From Display Name string
The string to be used as the caller id name (SIP From Display Name) presented to the destination (to number).
Optional
audioUrl Audio URL string
The URL of a file to be played back to the callee when the call is answered. The URL can point to either a WAV or MP3 file.
Optional
webhookUrl Webhook URL string
Use this field to override the URL to which Telnyx will send subsequent webhooks for this call.
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-dial-number
Version
0.0.2
App
Telnyx
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes