View as Markdown
TopMessage icon

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)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Send Message inputs
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