TopMessage ACTION
Send Message
Send messages via Whatsapp or SMS. See the documentation
- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's TopMessage account once, then configure and run Send Message 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: "topmessage-send-message",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
topmessage: { authProvisionId: "apn_xxxxxxx" },
from: "From",
to: ["To"],
},
})
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": "topmessage-send-message",
"configured_props": {
"topmessage": { "authProvisionId": "apn_xxxxxxx" },
"from": "From",
"to": ["To"]
}
}'// 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": "topmessage",
},
},
},
)
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: "topmessage-send-message",
arguments: {
from: "From",
to: ["To"],
},
})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 |
|---|---|---|
from From | string | The name your message will appear to be sent from. You can customize it with your company name (up to 11 characters) or use a virtual number Required |
to To | string[] | The recipient's mobile phone number(s) in international format Required |
text Text | string | Your message text to be sent to the recipient(s) Required |
shortenURLs Shorten URLs | boolean | Indicates whether HTTPS URLs in the text should be replaced with shortened URLs Optional |
templateId Template ID | string | Unique identifier of your sent template. You can check the available templates or create a new one from your account in the templates page Optional |
channel Channel | string | The communication channel your message will be sent through Optional |
schedule Schedule | string | Specifies the time when the message should be sent, i.e.: 2024-12-01T18:00:00Z. The scheduled time cannot be set for more than 1 year in the future 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
- topmessage-send-message
- Version
- 0.0.2
- App
- TopMessage
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗