CONNECT APP
Build with SMSAPI
Communication
- OAuth
MCP
Give your agent SMSAPI tools
Every SMSAPI 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 SMSAPI 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": "smsapi",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Create Contact:
const result = await mcp.callTool({
name: "smsapi-create-contact",
arguments: {
firstName: "First Name",
lastName: "Last Name",
},
})# 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": "smsapi",
}
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 Create Contact:
result = await session.call_tool("smsapi-create-contact", {
"firstName": "First Name",
"lastName": "Last Name",
})API PROXY
Call the SMSAPI API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the SMSAPI 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.smsapi.com/profile",
})
// Any allowed SMSAPI 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.smsapi.com/profile
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuc21zYXBpLmNvbS9wcm9maWxl?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run SMSAPI actions from your backend
Connect a user's SMSAPI account once, then run Create Contact 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: "smsapi-create-contact",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
smsapi: { authProvisionId: "apn_xxxxxxx" },
firstName: "First Name",
lastName: "Last Name",
},
})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="smsapi-create-contact",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"smsapi": {"authProvisionId": "apn_xxxxxxx"},
"firstName": "First Name",
"lastName": "Last Name",
},
)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": "smsapi-create-contact",
"configured_props": {
"smsapi": { "authProvisionId": "apn_xxxxxxx" },
"firstName": "First Name",
"lastName": "Last Name"
}
}'TOOLS
SMSAPI actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Create Contact
actionCreates a new contact in SMSAPI. See the documentationWritev0.0.2 -
List Phone Number Options
actionRetrieves available options for the Phone Number field.Read-onlyv0.0.1 -
List Sender Name Options
actionRetrieves available options for the Sender Name field.Read-onlyv0.0.1 -
Send Group Text Message
actionSends a group text message using SMSAPI. See the documentationWritev0.0.2 -
Send Text Message
actionSends a text message using SMSAPI. See the documentationWritev0.0.2
No SMSAPI triggers are available yet.
MULTI-APP
Use SMSAPI with other popular apps
Most products don't stop at one integration. Pair SMSAPI with the other apps your users rely on, and ship use cases that span both.
- App slug
- smsapi
- Authentication
- OAuth
- Categories
- Communication
- Actions
- 5
- Triggers
- 0
- API proxy
- Available
OAuth scopes
These are the scopes Pipedream's managed SMSAPI OAuth client requests when one of your users connects an account. Supply your own OAuth client to request a different set.
- sms
- sms_sender
- contacts
- profile