Send New SMS with Octopush SMS API

Pipedream makes it easy to connect APIs for Octopush SMS and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Send New SMS with the Octopush SMS API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

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

Configure the Send New SMS action
1. Connect your Octopush SMS account
2. Configure Text
3. Configure Phone Number
4. Configure First Name
5. Configure Last Name
6. Select a Type
7. Optional- Configure Sender
8. Optional- Configure Send At
9. Optional- Select a Purpose
10. Optional- Configure With Replies
11. Optional- Configure Simulation Mode
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Send New SMS with Octopush SMS API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Octopush SMS

Try it

Send New SMS with Octopush SMS API on New Submission from Typeform API

Typeform + Octopush SMS

Try it

Send New SMS with Octopush SMS API on New Submission (Instant) from Jotform API

Jotform + Octopush SMS

Try it

Send New SMS with Octopush SMS API on New Scheduled Tasks from Pipedream API

Pipedream + Octopush SMS

Try it

Send New SMS with Octopush SMS API on npm Download Counts from npm API

npm + Octopush SMS

Try it

Details#

This is a pre-built, source-available 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 New SMS on Octopush SMS

Description:Sends a new SMS using Octopush SMS. [See the documentation](https://dev.octopush.com/en/sms-gateway-api-documentation/send-sms/)

Version:0.0.1

Key:octopush_sms-send-new-sms

View on GitHub

Code#

import octopush from "../../octopush_sms.app.mjs";

export default {
  key: "octopush_sms-send-new-sms",
  name: "Send New SMS",
  description: "Sends a new SMS using Octopush SMS. [See the documentation](https://dev.octopush.com/en/sms-gateway-api-documentation/send-sms/)",
  version: "0.0.1",
  type: "action",
  props: {
    octopush,
    text: {
      type: "string",
      label: "Text",
      description: "The message text (from 1 to 1224 characters).",
    },
    phone: {
      type: "string",
      label: "Phone Number",
      description: "Phone number of the recipient",
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "First name of the recipient",
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Last name of the recipient",
    },
    type: {
      type: "string",
      label: "Type",
      description: "Campaign Type",
      options: [
        "sms_premium",
        "sms_low_cost",
      ],
    },
    sender: {
      type: "string",
      label: "Sender",
      description: "Sender of the message (if the user allows it), 3-11 alphanumeric characters (a-zA-Z0-9)",
      optional: true,
    },
    sendAt: {
      type: "string",
      label: "Send At",
      description: "When you want to send the sms campaign. Format: DateTime ISO8601 (for ex: “2018-10-03T07:42:39-07:00”)",
      optional: true,
    },
    purpose: {
      type: "string",
      label: "Purpose",
      description: "Campaign purpose",
      options: [
        "alert",
        "wholesale",
      ],
      optional: true,
    },
    withReplies: {
      type: "boolean",
      label: "With Replies",
      description: "Set to `true` to get back recipient replies",
      optional: true,
    },
    simulationMode: {
      type: "boolean",
      label: "Simulation Mode",
      description: "If this value is `true`, your request will be simulated, and you will receive a fake result",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.octopush.sendSMS({
      $,
      data: {
        text: this.text,
        recipients: [
          {
            phone_number: this.phone,
            first_name: this.firstName,
            last_name: this.lastName,
          },
        ],
        type: this.type,
        send_at: this.sendAt,
        purpose: this.purpose,
        with_replies: this.withReplies,
        simulation_mode: this.simulationMode,
      },
    });
    $.export("$summary", "Successfully send new 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.

Label	Prop	Type	Description
Octopush SMS	`octopush`	`app`	This component uses the Octopush SMS app.
Text	`text`	`string`	The message text (from 1 to 1224 characters).
Phone Number	`phone`	`string`	Phone number of the recipient
First Name	`firstName`	`string`	First name of the recipient
Last Name	`lastName`	`string`	Last name of the recipient
Type	`type`	`string`	Select a value from the drop down menu:`sms_premiumsms_low_cost`
Sender	`sender`	`string`	Sender of the message (if the user allows it), 3-11 alphanumeric characters (a-zA-Z0-9)
Send At	`sendAt`	`string`	When you want to send the sms campaign. Format: DateTime ISO8601 (for ex: “2018-10-03T07:42:39-07:00”)
Purpose	`purpose`	`string`	Select a value from the drop down menu:`alertwholesale`
With Replies	`withReplies`	`boolean`	Set to `true` to get back recipient replies
Simulation Mode	`simulationMode`	`boolean`	If this value is `true`, your request will be simulated, and you will receive a fake result