View as Markdown
VirtualSMS icon

VirtualSMS ACTION

Rent Number

Rent a real-SIM virtual phone number to receive an SMS verification code. Returns the order ID and assigned phone number — pair this with the New SMS Received trigger or the Check Messages action to retrieve the code. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's VirtualSMS account once, then configure and run Rent Number 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: "virtualsms-rent-number",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    virtualsms: { authProvisionId: "apn_xxxxxxx" },
    service: "Service",
    country: "Country",
  },
})

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.

Rent Number inputs
Property Type Description
service Service string
The service to receive an SMS verification code for (e.g. wa for WhatsApp, tg for Telegram, gm for Google/Gmail). Use the List Services action to discover all 700+ supported services and their codes.
Required Dynamic
country Country string
The numeric country ID expected by the VirtualSMS API (e.g., 0 for Russia, 1 for Ukraine). Use the List Countries action to discover all available countries and their numeric IDs. Omit for the cheapest available country.
Optional Dynamic

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
virtualsms-rent-number
Version
0.0.2
App
VirtualSMS
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes