View as Markdown
UltraMsg icon

UltraMsg ACTION

Send a Location

Send a location to a specified number. See the docs here
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's UltraMsg account once, then configure and run Send a Location 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: "ultramsg-send-location",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ultramsg: { authProvisionId: "apn_xxxxxxx" },
    to: "To",
    address: "Address",
  },
})

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 a Location inputs
Property Type Description
to To string
Phone with international format e.g. +1408XXXXXXX , or chatID for contact or group
Required Dynamic
address Address string
The address of your location. It will be used as a label
Required
lat Lat string
The latitude of your location. (e.g., 25.197197)
Required
lng Lng string
The longitude of your location. (e.g., 55.2721877)
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
ultramsg-send-location
Version
0.0.1
App
UltraMsg
Authentication
API key
Behavior
May modify external data