CONNECT APP
Build with SMSTools
Communication
- API key
MCP
Give your agent SMSTools tools
Every SMSTools 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 SMSTools 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": "smstools",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Add Contact to Group:
const result = await mcp.callTool({
name: "smstools-add-contact",
arguments: {
phone: "Phone Number",
groupid: "Group ID",
},
})# 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": "smstools",
}
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 Add Contact to Group:
result = await session.call_tool("smstools-add-contact", {
"phone": "Phone Number",
"groupid": "Group ID",
})API PROXY
Call the SMSTools API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the SMSTools 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.smsgatewayapi.com/v1/account",
})
// Any allowed SMSTools 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.smsgatewayapi.com/v1/account
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuc21zZ2F0ZXdheWFwaS5jb20vdjEvYWNjb3VudA?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run SMSTools actions from your backend
Connect a user's SMSTools account once, then run Add Contact to Group 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: "smstools-add-contact",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
smstools: { authProvisionId: "apn_xxxxxxx" },
phone: "Phone Number",
groupid: "Group ID",
},
})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="smstools-add-contact",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"smstools": {"authProvisionId": "apn_xxxxxxx"},
"phone": "Phone Number",
"groupid": "Group ID",
},
)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": "smstools-add-contact",
"configured_props": {
"smstools": { "authProvisionId": "apn_xxxxxxx" },
"phone": "Phone Number",
"groupid": "Group ID"
}
}'TOOLS
SMSTools actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Add Contact to Group
actionAdds a new contact to an existing contact list. See the documentationWritev0.0.2 -
Add Contact to Opt-Out List
actionAdds a selected contact to the opt-out list, stopping further communications. See the documentationWritev0.0.2 -
List Contact Number Options
actionRetrieves available options for the Contact Number field.Read-onlyv0.0.1 -
List Group ID Options
actionRetrieves available options for the Group ID field.Read-onlyv0.0.1 -
List Sender Options
actionRetrieves available options for the Sender field.Read-onlyv0.0.1 -
List Sub ID Options
actionRetrieves available options for the Sub ID field.Read-onlyv0.0.1 -
Send SMS or WhatsApp Message
actionSends a SMS or WhatsApp message to a specified contact. See the documentationWritev0.0.2
EVENTS
SMSTools triggers
Event sources your backend can deploy for users and receive through a webhook.
- App slug
- smstools
- Authentication
- API key
- Categories
- Communication
- Actions
- 7
- Triggers
- 1
- API proxy
- Available