View as Markdown
Z-API icon

Z-API ACTION

Send Text

Send a text to the specified phone. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Z-API account once, then configure and run Send Text 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: "z_api-send-text",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    z_api: { authProvisionId: "apn_xxxxxxx" },
    phone: "Phone",
    message: "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 Text inputs
Property Type Description
phone Phone string
Telephone number of the contact the message will be sent to, i.e.: 551199999999
Required
message Message string
The message to be sent
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
z_api-send-text
Version
0.0.2
App
Z-API
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes