View as Markdown
BulkGate icon

BulkGate ACTION

Send SMS

Sends an SMS message to a phone number. See the docs.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's BulkGate 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: "bulkgate-send-sms",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    bulkgate: { authProvisionId: "apn_xxxxxxx" },
    number: "Recipient Number",
    text: "Message Text",
  },
})

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
number Recipient Number string
The phone number you want to send the SMS to.
Required
text Message Text string
Text of SMS message (max. 612 characters, or 268 characters if Unicode is used), UTF-8 encoding
Required
unicode Is Unicode boolean
Yes/true/1 for Unicode SMS, no/false/0 for 7bit SMS.
Optional
senderId Sender ID string
Sender ID. If not set, the default sender ID is gSystem.
Optional
senderIdValue Sender ID Value string
Sender value - gOwn (e.g. 420 777 777 777), gText (e.g. BulkGate), gProfile (e.g. 423), gMobile or gPush (KEY).
Optional
country Country string
Provide the recipients numbers in an international format (with prefix, e.g. 44) or add the country code in ISO 3166-1 alpha-2 format (7820125799 + GB = 447820125799). See the country example request. If null, your set timezone will be used to fill the information
Optional
appId Application ID string
The ID of the application you want to use to send the SMS.
Optional
appToken Application Token string
The token of the application you want to use to send the SMS.
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
bulkgate-send-sms
Version
0.0.2
App
BulkGate
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes