← Textlocal

Send SMS with Textlocal API

Pipedream makes it easy to connect APIs for Textlocal and 1000+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Send SMS with the Textlocal API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Create a workflow to Send SMS with the Textlocal API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Send SMS action
    1. Connect your Textlocal account
    2. Configure Sender
    3. Configure Message
    4. Optional- Configure Numbers
    5. Optional- Select a Group Id
    6. Optional- Configure Simple Reply
    7. Optional- Configure Schedule Time
    8. Optional- Configure Receipt URL
    9. Optional- Configure Custom
    10. Optional- Configure Optouts
    11. Optional- Configure Validity
    12. Optional- Configure Unicode
    13. Optional- Configure Tracking Links
    14. Configure Test
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Send SMS with Textlocal API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Textlocal
 
Try it
Send SMS with Textlocal API on New Message from Discord API
Discord + Textlocal
 
Try it
Send SMS with Textlocal API on New Message In Channels from Slack API
Slack + Textlocal
 
Try it
Send SMS with Textlocal API on New Message in Channel from Discord Bot API
Discord Bot + Textlocal
 
Try it
Send SMS with Textlocal API on New Submission from Typeform API
Typeform + Textlocal
 
Try it

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Send SMS on Textlocal
Description:This Action can be used to send text messages to either individual numbers or entire contact groups. [See the docs here](https://api.txtlocal.com/docs/sendsms) Note: While both numbers and group_id are optional parameters, one or the other must be included in the request for the message to be sent.
Version:0.0.1
Key:textlocal-send-sms

Code

import textlocal from "../../textlocal.app.mjs";

export default {
  key: "textlocal-send-sms",
  name: "Send SMS",
  description:
    `This Action can be used to send text messages to either individual numbers or entire contact groups. [See the docs here](https://api.txtlocal.com/docs/sendsms)
    Note: While both numbers and group_id are optional parameters, one or the other must be included in the request for the message to be sent.`,
  version: "0.0.1",
  type: "action",
  props: {
    textlocal,
    sender: {
      propDefinition: [
        textlocal,
        "sender",
      ],
    },
    message: {
      propDefinition: [
        textlocal,
        "message",
      ],
    },
    numbers: {
      propDefinition: [
        textlocal,
        "numbers",
      ],
      description: "Note: While both numbers and group_id are optional parameters, one or the other must be included in the request for the message to be sent.",
      optional: true,
    },
    groupId: {
      propDefinition: [
        textlocal,
        "groupId",
      ],
      description: "Note: While both numbers and group_id are optional parameters, one or the other must be included in the request for the message to be sent.",
      optional: true,
    },
    simpleReply: {
      propDefinition: [
        textlocal,
        "simpleReply",
      ],
      optional: true,
    },
    scheduleTime: {
      propDefinition: [
        textlocal,
        "scheduleTime",
      ],
      optional: true,
    },
    receiptUrl: {
      propDefinition: [
        textlocal,
        "receiptUrl",
      ],
      optional: true,
    },
    custom: {
      propDefinition: [
        textlocal,
        "custom",
      ],
      optional: true,
    },
    optouts: {
      propDefinition: [
        textlocal,
        "optouts",
      ],
      optional: true,
    },
    validity: {
      propDefinition: [
        textlocal,
        "validity",
      ],
      optional: true,
    },
    unicode: {
      propDefinition: [
        textlocal,
        "unicode",
      ],
      optional: true,
    },
    trackingLinks: {
      propDefinition: [
        textlocal,
        "trackingLinks",
      ],
      optional: true,
    },
    test: {
      propDefinition: [
        textlocal,
        "test",
      ],
    },
  },
  async run({ $ }) {
    const params = {
      numbers: this.numbers,
      sender: this.sender,
      message: this.message,
      groupId: this.groupId,
      simple_reply: this.simpleReply,
      schedule_time: this.scheduleTime,
      receipt_url: this.receiptUrl,
      custom: this.custom,
      optouts: this.optouts,
      validity: this.validity,
      unicode: this.unicode,
      tracking_links: this.trackingLinks,
      test: this.test,
    };
    const response = await this.textlocal.sendSMS({
      $,
      params,
    });
    $.export("$summary", "Successfully sent SMS");
    return response;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
TextlocaltextlocalappThis component uses the Textlocal app.
Sendersenderstring

Use this field to specify the sender name for your message. This must be at least 3 characters in length but no longer than 11 alphanumeric characters or 13 numeric characters. If this is excluded it will use the default sender name configured on your account

Messagemessagestring

The message content. This parameter should be no longer than 765 characters. See Helpful Information for message length details. The message also must be URL Encoded to support symbols like &.

Numbersnumbersstring

Note: While both numbers and group_id are optional parameters, one or the other must be included in the request for the message to be sent.

Group IdgroupIdintegerSelect a value from the drop down menu.
Simple ReplysimpleReplyboolean

Set to true to enable the Simple Reply Service for the message. This will override any sender value, as a Simple Reply Service number will be used instead.

Schedule TimescheduleTimestring

This parameter can be used to specify a schedule date/time for your message, which should be provided in Unix timestamp format. Times should be provided in GMT.

Receipt URLreceiptUrlstring

Use this field to specify an alternative URL to which the delivery receipt(s) will be sent. See handling receipts documentation.

Customcustomstring

This value will be set against the message batch and will passed back in the delivery receipts. This allows you to match delivery receipts to their corresponding messages.

Optoutsoptoutsboolean

Can be set to true in order to check against your own opt-outs list and Textlocal's global opt-outs database. Your message will not be sent to numbers within these lists. If not provided defaults to false.

Validityvaliditystring

Can be set, up to 72 hours in advance, to say after which time, you don't want the message delivered. This should be in a Unix timestamp format.

Unicodeunicodeboolean

Set this value to true to specify that your message body will contain unicode characters. See Encoding/Decoding Unicode Documentation

Tracking LinkstrackingLinksboolean

Set this value to true to specify that the message contains links and they should be converted to short links (trackable in messenger), Please note that links must be url encoded before being placed into the message

Testtestboolean

Set this field to true to enable test mode, no messages will be sent and your credit balance will be unaffected. If not provided defaults to false

Authentication

Textlocal uses API keys for authentication. When you connect your Textlocal account, Pipedream securely stores the keys so you can easily authenticate to Textlocal APIs in both code and no-code steps.

Get your api key in your settings > API keys.

About Textlocal

Bulk SMS Marketing Service for Business | Send ...

More Ways to Use Textlocal

Triggers

New Contact from the Textlocal API

Emit new contact

 
Try it
New Inbox Message from the Textlocal API

Emit new inbox message.

 
Try it
New Sent API Message from the Textlocal API

Emit new message sent via Textlocal's API

 
Try it

Actions

Create Contact with the Textlocal API

Create a new contact. See the docs here

 
Try it