View as Markdown
Altiria icon

Altiria ACTION

Send SMS

Send an SMS message. The message will be sent to the phone numbers you specify. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Altiria account once, then configure and run Send 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: "altiria-send-sms",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    altiria: { authProvisionId: "apn_xxxxxxx" },
    destination: ["Destination Phone Numbers"],
    msg: "Message",
  },
})

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 SMS inputs
Property Type Description
destination Destination Phone Numbers string[]
The phone numbers to which the message will be sent. Each number will be specified in international numbering format without the prefix 00 or the sign +. Eg: 34645852126. It is essential to include the country prefix (34 for Spain) so that the message reaches the expected destination. It must not exceed 16 digits. In any case, it is recommended not to exceed 100 phone numbers per request.
Required
msg Message string
Message to send. The list of valid characters and the maximum allowed length is detailed in section 2.4 of the documentation. It cannot be empty (empty string). Mobile web identifiers can be added to generate unique shortened links in the message body. See section 2.5 for more details on mobile webs.
Required

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
altiria-send-sms
Version
0.0.2
App
Altiria
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes