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)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "telnyx-send-fax",
"configured_props": {
"telnyx": { "authProvisionId": "apn_xxxxxxx" },
"faxAppId": "Fax Application ID",
"mediaUrl": "Media URL"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "telnyx",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "telnyx-send-fax",
arguments: {
faxAppId: "Fax Application ID",
mediaUrl: "Media URL",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| 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
- Source
- View on GitHub ↗