CONNECT APP
Build with Telnyx
Developer Tools
- API key
MCP
Give your agent Telnyx tools
Every Telnyx action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Telnyx account for each tool call — you store no tokens.
// 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()
// e.g. run Dial Number:
const result = await mcp.callTool({
name: "telnyx-dial-number",
arguments: {
callControlAppId: "Call Control Application ID",
phoneNumber: "Phone Number",
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"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",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Dial Number:
result = await session.call_tool("telnyx-dial-number", {
"callControlAppId": "Call Control Application ID",
"phoneNumber": "Phone Number",
})API PROXY
Call the Telnyx API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Telnyx API with the connected user's credentials attached. You store no tokens and write no refresh logic.
const resp = await pd.proxy.get({
externalUserId: "{external_user_id}", // any stable ID for this user in your system
accountId: "apn_xxxxxxx",
url: "https://api.telnyx.com/v2/available_phone_numbers",
})
// Any allowed Telnyx endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.# The path segment is the target URL, URL-safe base64 encoded:
# https://api.telnyx.com/v2/available_phone_numbers
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkudGVsbnl4LmNvbS92Mi9hdmFpbGFibGVfcGhvbmVfbnVtYmVycw?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Telnyx actions from your backend
Connect a user's Telnyx account once, then run Dial Number on their behalf from your own code — TypeScript, Python, or plain HTTP.
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",
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="telnyx-dial-number",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"telnyx": {"authProvisionId": "apn_xxxxxxx"},
"callControlAppId": "Call Control Application ID",
"phoneNumber": "Phone Number",
},
)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-dial-number",
"configured_props": {
"telnyx": { "authProvisionId": "apn_xxxxxxx" },
"callControlAppId": "Call Control Application ID",
"phoneNumber": "Phone Number"
}
}'TOOLS
Telnyx actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Dial Number
actionDial a number or SIP URI from a given Call Control App. See the documentationWritev0.0.2 -
Get Messaging Profiles
actionGet a list of messaging profiles. See the documentationRead-onlyv0.0.6 -
Get Phone Numbers
actionGet a list of phone numbers. See the documentationRead-onlyv0.0.5 -
List Call Control Application ID Options
actionRetrieves available options for the Call Control Application ID field.Read-onlyv0.0.1 -
List Fax Application ID Options
actionRetrieves available options for the Fax Application ID field.Read-onlyv0.0.1 -
List Messaging Profile Id Options
actionRetrieves available options for the Messaging Profile Id field.Read-onlyv0.0.1 -
List Phone Number Options
actionRetrieves available options for the Phone Number field.Read-onlyv0.0.1 -
Retrieve a Message
actionRetrieve a message. See the documentationRead-onlyv0.0.4 -
Send Fax
actionSends a PDF document to a specified fax number using the Telnyx Fax API. See the documentationWritev0.0.2 -
Send Group Message
actionSend a group MMS message. See the documentationWritev0.0.4 -
Send Message
actionSend an SMS or MMS message. See the documentationWritev0.0.6
MULTI-APP
Use Telnyx with other popular apps
Most products don't stop at one integration. Pair Telnyx with the other apps your users rely on, and ship use cases that span both.
- App slug
- telnyx
- Authentication
- API key
- Categories
- Developer Tools
- Actions
- 11
- Triggers
- 2
- API proxy
- Available