View as Markdown
Telnyx icon

Telnyx ACTION

Send Fax

Sends a PDF document to a specified fax number using the Telnyx Fax API. 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 Send Fax 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-send-fax",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    telnyx: { authProvisionId: "apn_xxxxxxx" },
    faxAppId: "Fax Application ID",
    mediaUrl: "Media URL",
  },
})

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.

Send Fax inputs
Property Type Description
faxAppId Fax Application ID string
The connection/application ID to send the fax with.
Required Dynamic
mediaUrl Media URL string
The URL to the PDF used for the fax's media.
Required
phoneNumber Phone Number string
The phone number to send the message from.
Required Dynamic
to To string
The phone number, in E.164 format, the fax will be sent to or SIP URI
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
quality Quality string
The quality of the fax. The ultra settings provides the highest quality available, but also present longer fax processing times. ultra_light is best suited for images, while ultra_dark is best suited for text.
Optional
ts38Enabled TS38 Enabled boolean
The flag to disable the T.38 protocol
Optional
monochrome Monochrome boolean
The flag to enable monochrome, true creates black and white fax results.
Optional
storeMedia Store Media boolean
Should fax media be stored on temporary URL?
Optional
webhookUrl Webhook URL string
Use this field to override the URL to which Telnyx will send subsequent webhooks for this fax.
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-send-fax
Version
0.0.2
App
Telnyx
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes