View as Markdown
Octopush SMS icon

Octopush SMS ACTION

Send New SMS

Sends a new SMS using Octopush SMS. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Octopush SMS account once, then configure and run Send New SMS 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: "octopush_sms-send-new-sms",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    octopush_sms: { authProvisionId: "apn_xxxxxxx" },
    text: "Text",
    phone: "Phone Number",
  },
})

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 New SMS inputs
Property Type Description
text Text string
The message text (from 1 to 1224 characters).
Required
phone Phone Number string
Phone number of the recipient
Required
firstName First Name string
First name of the recipient
Required
lastName Last Name string
Last name of the recipient
Required
type Type string
Campaign Type
Required
sender Sender string
Sender of the message (if the user allows it), 3-11 alphanumeric characters (a-zA-Z0-9)
Optional
sendAt Send At string
When you want to send the sms campaign. Format: DateTime ISO8601 (for ex: “2018-10-03T07:42:39-07:00”)
Optional
purpose Purpose string
Campaign purpose
Optional
withReplies With Replies boolean
Set to true to get back recipient replies
Optional
simulationMode Simulation Mode boolean
If this value is true, your request will be simulated, and you will receive a fake result
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
octopush_sms-send-new-sms
Version
0.0.3
App
Octopush SMS
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes