View as Markdown
LabsMobile icon

LabsMobile ACTION

Send SMS

Sends a new SMS message. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's LabsMobile 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: "labsmobile-send-sms",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    labsmobile: { authProvisionId: "apn_xxxxxxx" },
    msisdn: [10],
    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 SMS inputs
Property Type Description
msisdn Msisdn integer[]
Parameter that includes a mobile number recipient. The number must include the country code without '+' ó '00'. Each customer account has a maximum number of msisdn per sending. See the terms of your account to see this limit.
Required
message Message string
The message to be sent. The maximum message length is 160 characters. Only characters in the GSM 3.38 7bit alphabet, found at the end of this document, are valid. Otherwise you must send ucs2 parameter.
Required
tpoa Tpoa string
Sender of the message. May have a numeric (maximum length, 14 digits) or an alphanumeric (maximum capacity, 11 characters) value. The messaging platform assigns a default sender if this parameter is not included. By including the sender's mobile number, the message recipient can easily respond from their mobile phone with the "Reply" button. The sender can only be defined in some countries due to the restrictions of the operators. Otherwise the sender is a random numeric value.
Optional
subid Subid string
Message ID included in the ACKs (delivery confirmations). It is a unique delivery ID issued by the API client. It has a maximum length of 20 characters.
Optional
label Label string
Identifies the message for statistical purposes. WebSMS and other applications use this field to organize and record the message. Maximum capacity of 255 characters. Typical information contained in this field: user that has sent the message, application or module, etc. ...
Optional
test Test boolean
If the value is true, the message will be considered a test. It will not be sent to the GSM network and, therefore, will not be received on any mobile devices. However, these messages are accessible using online search tools. This parameter is intended to enable performing integration tests without an associated cost. Operator and handset confirmations will not be received.
Optional
ackurl Ackurl string
URL to which the corresponding delivery confirmation notifications will be sent. In the preferences section of WebSMS application you can set the default value for ackurl for all cases without having to send this parameter in each sending.
Optional
shortlink Shortlink boolean
If this field is present in the message and has a value of true the first URL would be replace by a short link of LabsMobile (format: http://lm0.es/XXXXX). The statistics of visits can be seen in WebSMS application or can be received in an url with the parameter clickurl.
Optional
clickurl Click URL string
URL to which the corresponding click confirmation notifications will be sent if the parameter shortlink is enabled. In the preferences section of WebSMS application you can set the default value for clickurl for all cases without having to send this parameter in each sending.
Optional
scheduled Scheduled string
The message will be sent at the date and time indicated in this field. If this field has not been specified, the message will be sent immediately. Format: YYYY-MM-DD HH:MM:SS. IMPORTANT: the value of this field must be expressed using GMT time.
Optional
long Long boolean
If this field is present in the message and has a value of true, the message field may contain up to 459 characters. Each 153 characters will be considered a single message (in terms of charges) and the recipient will receive one, concatenated message. IMPORTANT: This option is only available in some countries due to the restrictions of the operators.
Optional
crt CRT string
If this field is present in the message, it will be considered a certified SMS message. An email with the delivery certificate in an attachment will be sent to the address contained in this parameter. IMPORTANT: This option is only implemented in some countries.
Optional
crtId CRT ID string
If the message is a certified SMS message this field will be set as the tax identification number of the sender company or organization. You would see this value in the certificate in PDF format.
Optional
crtName CRT Name string
If the message is a certified SMS message this field will be set as the name of the sender company or organization. You would see this value in the certificate in PDF format.
Optional
ucs2 UCS 2 boolean
If this field is present in the message the message can contain any character in the UCS-2 alphabet. In this case the capacity of the message is 70 characters and can be sent concatenated to a maximum of 500 characters.
Optional
nofilter No Filter boolean
If this field is present the platform won't apply the duplicate filter, so no message will be blocked by this filter.
Optional
parameters Parameters object
This field contains values to replace parameters in the text of the message. The message can contain one or more parameters (with the following format: %name%, %fieldn%, etc.). It is necessary to specify the value of each parameter for each of the recipients or establish a default value. Example: {"parameters": [{"name": {"msisdn":"12015550123", "value":"John"}}, {"name": {"msisdn":"default", "value":"Client"}}]}
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
labsmobile-send-sms
Version
0.0.3
App
LabsMobile
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes